File Coverage

blib/lib/DBIx/Custom.pm

Criterion	Covered	Total	%
statement	754	861	87.5
branch	306	396	77.2
condition	107	157	68.1
subroutine	76	89	85.3
pod	35	41	85.3
total	1278	1544	82.7

use 5.008007;
package DBIx::Custom;
use Object::Simple -base;

our $VERSION = '0.44';

use Carp 'confess';
use DBI;
use DBIx::Custom::Result;
use DBIx::Custom::Where;
use DBIx::Custom::Model;
use DBIx::Custom::Order;
use DBIx::Custom::Util qw/_array_to_hash _subname _deprecate/;
use DBIx::Custom::Mapper;
use DBIx::Custom::NotExists;
use DBIx::Custom::Query;
use DBIx::Connector;

use Encode qw/encode encode_utf8 decode_utf8/;
use Scalar::Util qw/weaken/;

has [qw/dsn password quote user exclude_table user_table_info
     user_column_info safety_character/];
has connector => 1;
has option => sub { {} };
has default_option => sub {
  {
    RaiseError => 1,
    PrintError => 0,
    AutoCommit => 1
  }
};
has filters => sub {
  {
    encode_utf8 => sub { encode_utf8($_[0]) },
    decode_utf8 => sub { decode_utf8($_[0]) }
  }
};
has last_sql => '';
has models => sub { {} };
has now => sub {
  sub {
    my ($sec, $min, $hour, $mday, $mon, $year) = localtime;
    $mon++;
    $year += 1900;
    my $now = sprintf("%04d-%02d-%02d %02d:%02d:%02d",
      $year, $mon, $mday, $hour, $min, $sec);
    return $now;
  }
};
has result_class  => 'DBIx::Custom::Result';
has separator => '.';

has mytable_symbol => '__MY__';

sub create_result {
  my ($self, $sth) = @_;

  return $self->result_class->new(sth => $sth, dbi => $self);
}

sub column {
  my $self = shift;
  my $option = pop if ref $_[-1] eq 'HASH';
  my $real_table = shift;
  my $columns = shift;
  my $table = $option->{alias} || $real_table;

  # Columns
  if (!defined $columns || $columns eq '*') {
    $columns = $self->model($real_table)->columns;
  }

  # Separator
  my $separator = $self->separator;

  # . is replaced
  my $t = $table;
  $t =~ s/\./$separator/g;

  # Column clause
  my @column;
  $columns ||= [];
  push @column, $self->_tq($table) . "." . $self->q($_) .
    " as " . $self->q("${t}${separator}$_")
    for @$columns;

  return join (', ', @column);
}

sub connect {
  my $self;

  if (ref $_[0]) {
    $self = shift;
  }
  else {
    $self = shift->new(@_);
  }

  my $connector = $self->connector;

  if (!ref $connector && $connector) {
    my $dsn = $self->dsn;
    my $user = $self->user;
    my $password = $self->password;
    my $option = $self->option;
    my $connector = DBIx::Connector->new($dsn, $user, $password,
      {%{$self->default_option} , %$option});
    $self->connector($connector);
  }

  # Connect
  $self->dbh;

  return $self;
}

sub dbh {
  my $self = shift;

  # Set
  if (@_) {
    $self->{dbh} = $_[0];

    return $self;
  }

  # Get
  else {
    # From Connction manager
    if (my $connector = $self->connector) {
      confess "connector must have dbh() method " . _subname
        unless ref $connector && $connector->can('dbh');

      $self->{dbh} = $connector->dbh;
    }

    # Connect
    $self->{dbh} ||= $self->_connect;

    # Quote
    if (!defined $self->quote) {
      my $driver = $self->_driver;
      my $quote =  $driver eq 'odbc' ? '[]'
        : $driver eq 'ado' ? '[]'
        : $driver eq 'mysql' ? '`'
        : '"';
      $self->quote($quote);
    }

    return $self->{dbh};
  }
}

sub delete {
  my ($self, %opt) = @_;

  # Don't allow delete all rows
  confess qq{delete method where or id option must be specified } . _subname
    if !$opt{where} && !defined $opt{id} && !$opt{allow_delete_all};

  # Where
  my $where;
  if (defined $opt{id}) {
    $where = $self->_id_to_param($opt{id}, $opt{primary_key}, $opt{table}) ;
  }
  else {
    $where = $opt{where};
  }
  my $w = $self->_where_clause_and_param($where);

  # Delete statement
  my $sql = "delete ";
  $sql .= "$opt{prefix} " if defined $opt{prefix};
  $sql .= "from " . $self->_tq($opt{table}) . " $w->{clause} ";

  # Execute query
  $self->execute($sql, $w->{param}, %opt);
}

sub delete_all { shift->delete(@_, allow_delete_all => 1) }

sub create_model {
  my $self = shift;

  my $opt;
  if (@_ % 2 != 0 && !ref $_[0]) {
    $opt = {table => shift, @_};
  }
  else {
    $opt = ref $_[0] eq 'HASH' ? $_[0] : {@_};
  }

  # Options
  $opt->{dbi} = $self;
  my $model_class = delete $opt->{model_class} || 'DBIx::Custom::Model';
  my $model_name  = delete $opt->{name};
  my $model_table = delete $opt->{table};
  $model_name ||= $model_table;
  my $column_name_lc = delete $opt->{column_name_lc};

  # Create model
  my $model = $model_class->new($opt);
  weaken $model->{dbi};
  $model->table($model_table) unless $model->table;
  $model->name($model_name);

  if (!$model->columns || !@{$model->columns}) {
    $model->columns($self->get_columns_from_db($model->table, {column_name_lc => $column_name_lc}));
  }

  # Set model
  $self->model($model_name, $model);

  return $self->model($model->name);
}

sub execute {
  my $self = shift;
  my $sql = shift;

  # Options
  my $param;
  $param = shift if @_ % 2;
  $param ||= {};
  my %opt = @_;

  # Append
  $sql .= $opt{append} if defined $opt{append};

  # Parse named place holder
  my $safe_char = $self->{safety_character};
  my $place_holder_re = $safe_char eq 'a-zA-Z0-9_'
    ? qr/(.*?[^\\]):([$safe_char\.]+)(?:\{(.*?)\})?(.*)/so
    : qr/(.*?[^\\]):([$safe_char\.]+)(?:\{(.*?)\})?(.*)/s;
  my $source_sql = $sql;
  $source_sql =~ s/([0-9]):/$1\\:/g;
  my $parsed_sql = '';
  my $columns;
  while ($source_sql =~ /$place_holder_re/) {
    push @$columns, $2;
    ($parsed_sql, $source_sql) = defined $3 ?
      ($parsed_sql . "$1$2 $3 ?", " $4") : ($parsed_sql . "$1?", " $4");
  }
  $parsed_sql .= $source_sql;
  $parsed_sql =~ s/\\:/:/g if index($parsed_sql, "\\:") != -1;

  # Edit SQL after building
  my $after_build_sql = $opt{after_build_sql};
  $parsed_sql = $after_build_sql->($parsed_sql) if $after_build_sql;

  # Type rule
  my $type_filters;
  if ($self->{_type_rule_is_called}) {
    $type_filters = {};
    unless ($opt{type_rule_off}) {
      my $tables = $opt{table} || [];
      $tables = [$tables] unless ref $tables eq 'ARRAY';

      # Tables
      my $main_table = @{$tables}[-1];

      my $type_rule_off_parts = {
        1 => $opt{type_rule1_off},
        2 => $opt{type_rule2_off}
      };
      for my $i (1, 2) {
        unless ($type_rule_off_parts->{$i}) {
          $type_filters->{$i} = {};
          my $table_alias = $opt{table_alias} || {};
          for my $alias (keys %$table_alias) {
            my $table = $table_alias->{$alias};

            for my $column (keys %{$self->{"_into$i"}{key}{$table} || {}}) {
              $type_filters->{$i}->{"$alias.$column"} = $self->{"_into$i"}{key}{$table}{$column};
            }
          }
          $type_filters->{$i} = {%{$type_filters->{$i}}, %{$self->{"_into$i"}{key}{$main_table} || {}}}
            if $main_table;
        }
      }
    }
  }

  # Replace filter name to code
  my $filter = $opt{filter};
  if (defined $filter) {
    if (ref $opt{filter} eq 'ARRAY') {
      $filter = _array_to_hash($filter);
    }

    for my $column (keys %$filter) {
      my $name = $filter->{$column};
      if (!defined $name) {
        $filter->{$column} = undef;
      }
      elsif (ref $name ne 'CODE') {
        confess qq{Filter "$name" is not registered" } . _subname
          unless exists $self->filters->{$name};
        $filter->{$column} = $self->filters->{$name};
      }
    }
  }

  # Bind type
  my $bind_type = $opt{bind_type};
  $bind_type = _array_to_hash($bind_type) if ref $bind_type eq 'ARRAY';

  # Create query
  my $query = DBIx::Custom::Query->new;
  $query->param($param);
  $query->sql($parsed_sql);
  $query->columns($columns);
  $query->bind_type($bind_type);

  $query->{_filter} = $filter;
  $query->{_type_filters} = $type_filters;
  $query->{_into1} = $self->{_into1};
  $query->{_into2} = $self->{_into2};

  # Has filter
  $query->{_f} = defined $filter || defined $type_filters;

  # Build bind values
  $query->build;

  # Statement handle
  my $sth;
  my $reuse_sth;
  $reuse_sth = $opt{reuse}->{$parsed_sql} if $opt{reuse};
  if ($reuse_sth) {
    $sth = $reuse_sth;
  }
  else {
    # Prepare statement handle
    eval { $sth = $self->dbh->prepare($parsed_sql) };
    if ($@) {
      $self->_confess($@, qq{. Following SQL is executed.\n}
                      . qq{$parsed_sql\n} . _subname);
    }
    $opt{reuse}->{$parsed_sql} = $sth if $opt{reuse};
  }

  # Execute
  my $affected;
  eval {
    my $bind_values = $query->bind_values;
    if ($bind_type) {
      my $bind_value_types = $query->bind_value_types;
      $sth->bind_param($_ + 1, $bind_values->[$_],
          $bind_value_types->[$_] ? $bind_value_types->[$_] : ())
        for (0 .. @$bind_values - 1);
      $affected = $sth->execute;
    }
    else { $affected = $sth->execute(@$bind_values) }

    # Save sql
    $self->{last_sql} = $parsed_sql;

    # DEBUG message
    if ($ENV{DBIX_CUSTOM_DEBUG}) {
      warn "SQL:\n" . $parsed_sql . "\n";
      my @output;
      for my $value (@$bind_values) {
        $value = 'undef' unless defined $value;
        $value = encode($ENV{DBIX_CUSTOM_DEBUG_ENCODING} || 'UTF-8', $value)
          if utf8::is_utf8($value);
        push @output, $value;
      }
      warn "Bind values: " . join(', ', @output) . "\n\n";
    }
  };

  $self->_confess($@, qq{. Following SQL is executed.\n}
    . qq{$parsed_sql\n} . _subname) if $@;

  # Reulst of select statement
  if ($sth->{NUM_OF_FIELDS}) {
    # Result
    my $result = $self->result_class->new(
      sth => $sth,
      dbi => $self,
    );

    if ($self->{_type_rule_is_called}) {
      $result->type_rule({
        from1 => $self->type_rule->{from1},
        from2 => $self->type_rule->{from2}
      });
      $result->{_has_filter} = 1;
    }

    return $result;
  }
  # Affected of insert, update, or delete
  else {
    return $affected
  }
}

sub include_model {
  my ($self, $name_space, $model_infos) = @_;

  # Name space
  $name_space ||= '';

  # Get Model information
  unless ($model_infos) {

    # Load name space module
    confess qq{"$name_space" is invalid class name } . _subname
      if $name_space =~ /[^\w:]/;
    eval "use $name_space";
    confess qq{Name space module "$name_space.pm" is needed. $@ } . _subname
      if $@;

    # Search model modules
    my $name_space_dir = $name_space;
    $name_space_dir =~ s/::/\//g;
    my $path = $INC{"$name_space_dir.pm"};
    $path =~ s/\.pm$//;
    opendir my $dh, $path
      or confess qq{Can't open directory "$path": $! } . _subname
    my @modules;
    while (my $file = readdir $dh) {
      my $file_abs = "$path/$file";
      if (-d $file_abs) {
        next if $file eq '.' || $file eq '..';
        opendir my $fq_dh, $file_abs
          or confess qq{Can't open directory "$file_abs": $! } . _subname;
        while (my $fq_file = readdir $fq_dh) {
          my $fq_file_abs = "$file_abs/$fq_file";
          push @modules, "${file}::$fq_file" if -f $fq_file_abs;
        }
        close $fq_dh;
      }
      elsif(-f $file_abs) { push @modules, $file }
    }
    close $dh;

    $model_infos = [];
    for my $module (@modules) {
      if ($module =~ s/\.pm$//) { push @$model_infos, $module }
    }
  }

  # Include models
  for my $model_info (@$model_infos) {

    # Load model
    my $model_class;
    my $model_name;
    my $model_table;
    if (ref $model_info eq 'HASH') {
      $model_class = $model_info->{class};
      $model_name  = $model_info->{name};
      $model_table = $model_info->{table};

      $model_name  ||= $model_class;
      $model_table ||= $model_name;
    }
    else {
      $model_class = $model_name = $model_table = $model_info;
    }

    $model_class =~ s/\./::/g;
    $model_name =~ s/::/./;
    $model_table =~ s/::/./;

    my $mclass = "${name_space}::$model_class";
    confess qq{"$mclass" is invalid class name } . _subname
      if $mclass =~ /[^\w:]/;
    unless ($mclass->can('new')) {
      eval "require $mclass";
      confess "$@ " . _subname if $@;
    }

    # Create model
    my $opt = {};
    $opt->{model_class} = $mclass if $mclass;
    $opt->{name}        = $model_name if $model_name;
    $opt->{table}       = $model_table if $model_table;

    $self->create_model($opt);
    1;
  }

  return $self;
}

sub like_value { sub { "%$_[0]%" } }

sub mapper {
  my $self = shift;
  return DBIx::Custom::Mapper->new(@_);
}

sub merge_param {
  my ($self, $param1, $param2) = @_;

  # Merge parameters
  my $merged_param = {%$param1};
  for my $column (keys %$param2) {
    if (exists $merged_param->{$column}) {
      $merged_param->{$column} = [$merged_param->{$column}]
        unless ref $merged_param->{$column} eq 'ARRAY';
      push @{$merged_param->{$column}},
        ref $param2->{$column} eq 'ARRAY' ? @{$param2->{$column}} : $param2->{$column};
    }
    else { $merged_param->{$column} = $param2->{$column} }
  }

  return $merged_param;
}

sub model {
  my ($self, $name, $model) = @_;

  # Set model
  if ($model) {
    $self->models->{$name} = $model;
    return $self;
  }

  # Check model existence
  confess qq{Model "$name" is not yet created } . _subname
    unless $self->models->{$name};

  # Get model
  return $self->models->{$name};
}

sub mycolumn {
  my ($self, $table, $columns) = @_;

  if (!$columns || $columns eq '*') {
    $columns = $self->model($table)->columns;
  }

  # Create column clause
  my @column;
  push @column, $self->_tq($table) . "." . $self->q($_) . " as " . $self->q($_)
    for @$columns;

  return join (', ', @column);
}

sub new {
  my $self = shift;

  # Same as DBI connect argument
  if (@_ > 0 && !ref $_[0] && $_[0] =~ /:/) {
    my $dsn = shift;
    my $user = shift;
    my $password = shift;
    my $dbi_option = shift || {};
    my $attrs = shift || {};
    $attrs->{dsn} = $dsn;
    $attrs->{user} = $user;
    $attrs->{password} = $password;
    $attrs->{option} = $dbi_option;
    $self = $self->SUPER::new($attrs);
  }
  else {
    $self = $self->SUPER::new(@_);
  }

  # Check attributes
  my @attrs = keys %$self;
  for my $attr (@attrs) {
    confess qq{Invalid attribute: "$attr" } . _subname
      unless $self->can($attr);
  }

  $self->{safety_character} = 'a-zA-Z0-9_'
    unless exists $self->{safety_character};

  return $self;
}

sub not_exists { DBIx::Custom::NotExists->singleton }

sub order {
  my $self = shift;
  return DBIx::Custom::Order->new(dbi => $self, @_);
}

sub q { shift->_tq($_[0], $_[1], whole => 1) }

sub _tq {
  my ($self, $value, $quotemeta, %opt) = @_;

  my $quote = $self->{quote} || $self->quote || '';

  my $q = substr($quote, 0, 1) || '';
  my $p;
  if (defined $quote && length $quote > 1) {
    $p = substr($quote, 1, 1);
  }
  else { $p = $q }

  if ($quotemeta) {
    $q = quotemeta($q);
    $p = quotemeta($p);
  }

  if ($opt{whole}) { return "$q$value$p" }
  else {
    my @values = split /\./, $value;
    push @values, '' unless @values;
    for my $v (@values) { $v = "$q$v$p" }
    return join '.', @values;
  }
}

sub register_filter {
  my $self = shift;

  # Register filter
  my $filters = ref $_[0] eq 'HASH' ? $_[0] : {@_};
  $self->filters({%{$self->filters}, %$filters});

  return $self;
}

sub select {
  my $self = shift;
  my $column = shift if @_ % 2;
  my %opt = @_;
  $opt{column} = $column if defined $column;

  # Table
  my $table = $opt{table};

  # Found tables;
  my $found_tables = [];
  push @$found_tables, $table if defined $table;

  my $param = delete $opt{param} || {};

  # Select statement
  my $sql = 'select ';

  # Prefix
  $sql .= "$opt{prefix} " if defined $opt{prefix};

  # Column
  if (defined $opt{column}) {
    my $columns
      = ref $opt{column} eq 'ARRAY' ? $opt{column} : [$opt{column}];
    for my $column (@$columns) {
      if (ref $column eq 'HASH') {
        my $mytable_symbol = $opt{mytable_symbol} || $self->mytable_symbol;
        my $table = (keys %$column)[0];
        my $columns = $column->{$table};

        if ($table eq $mytable_symbol) {
          $column = $self->mycolumn($found_tables->[0] => $columns);
        }
        else {
          $column = $self->column($table => $columns);
        }
      }
      unshift @$found_tables, @{$self->_search_tables($column)} if $table;
      $sql .= "$column, ";
    }
    $sql =~ s/, $/ /;
  }
  else { $sql .= '* ' }

  # Execute query without table
  return $self->execute($sql, {}, %opt) unless $table;

  # Table
  $sql .= 'from ';
  $sql .= $self->_tq($found_tables->[-1] || '') . ' ';
  $sql =~ s/, $/ /;

  # Add tables in parameter
  unshift @$found_tables, @{$self->_search_tables(join(' ', keys %$param) || '')};

  # Where
  my $where;
  if (defined $opt{id}) {
    $where = $self->_id_to_param($opt{id}, $opt{primary_key}, @$found_tables ? $found_tables->[-1] : undef) ;
  }
  else {
    $where = $opt{where};
  }
  my $w = $self->_where_clause_and_param($where, $opt{id});
  $param = $self->merge_param($param, $w->{param});

  # Search table names in where clause
  unshift @$found_tables, @{$self->_search_tables($w->{clause})};

  # Search table names in append option
  if (defined(my $append = $opt{append})) {
    unshift @$found_tables, @{$self->_search_tables($append)};
  }

  # Join statement
  my $join = [];
  if (defined $opt{join}) {
    my $opt_join = $opt{join};
    if (ref $opt_join eq 'ARRAY') {
      push @$join, @$opt_join;
    }
    else { push @$join, $opt_join }
  }
  if (defined $w->{join}) {
    my $where_join = $w->{join};
    if (ref $where_join eq 'ARRAY') {
      push @$join, @$where_join;
    }
    else { push @$join, $where_join }
  }
  $self->_push_join(\$sql, $join, $found_tables) if @$join;

  # Add where clause
  $sql .= "$w->{clause} ";

  # Execute query
  return $self->execute($sql, $param, %opt);
}

sub setup_model {
  my ($self, %opt) = @_;

  _deprecate('0.39', "DBIx::Custom::setup method is DEPRECATED! columns is automatically set when create_model or include_model is called");

  return $self;
}

sub insert {
  my $self = shift;

  # Options
  my $params = @_ % 2 ? shift : undef;
  my %opt = @_;
  $params ||= {};

  # Insert statement
  my $sql = "insert ";
  $sql .= "$opt{prefix} " if defined $opt{prefix};
  $sql .= "into " . $self->_tq($opt{table}) . " ";

  my $multi;
  if (ref $params eq 'ARRAY') { $multi = 1 }
  else { $params = [$params] }

  # Created time and updated time
  if (defined $opt{ctime} || defined $opt{mtime}) {

    for my $param (@$params) {
      $param = {%$param};
    }
    my $now = $self->now;
    $now = $now->() if ref $now eq 'CODE';
    if (defined $opt{ctime}) {
      $_->{$opt{ctime}} = $now for @$params;
    }
    if (defined $opt{mtime}) {
      $_->{$opt{mtime}} = $now for @$params;
    }
  }

  # Merge id to parameter
  if (defined $opt{id} && !$multi) {

    _deprecate('0.39', "DBIx::Custom::insert method's id option is DEPRECATED!");

    for my $param (@$params) {
      $param = {%$param};
    }

    confess "insert id option must be specified with primary_key option"
      unless $opt{primary_key};
    $opt{primary_key} = [$opt{primary_key}] unless ref $opt{primary_key} eq 'ARRAY';
    $opt{id} = [$opt{id}] unless ref $opt{id} eq 'ARRAY';
    for (my $i = 0; $i < @{$opt{primary_key}}; $i++) {
      my $key = $opt{primary_key}->[$i];
      next if exists $params->[0]->{$key};
      $params->[0]->{$key} = $opt{id}->[$i];
    }
  }

  if ($opt{bulk_insert}) {
    $sql .= $self->_multi_values_clause($params, {wrap => $opt{wrap}}) . " ";
    my $new_param = {};
    $new_param->{$_} = [] for keys %{$params->[0]};
    for my $param (@$params) {
      push @{$new_param->{$_}}, $param->{$_} for keys %$param;
    }
    $params = [$new_param];
  }
  else {
    $sql .= $self->values_clause($params->[0], {wrap => $opt{wrap}}) . " ";
  }

  # Execute query
  if (@$params > 1) {
    for my $param (@$params) {
      $self->execute($sql, $param, %opt);
    }
  }
  else {
    $self->execute($sql, $params->[0], %opt);
  }
}

sub update {
  my $self = shift;

  # Options
  my $param = @_ % 2 ? shift : undef;
  my %opt = @_;
  $param ||= {};

  # Don't allow update all rows
  confess qq{update method where option must be specified } . _subname
    if !$opt{where} && !defined $opt{id} && !$opt{allow_update_all};

  # Created time and updated time
  if (defined $opt{mtime}) {
    $param = {%$param};
    my $now = $self->now;
    $now = $now->() if ref $now eq 'CODE';
    $param->{$opt{mtime}} = $self->now->();
  }

  # Assign clause
  my $assign_clause = $self->assign_clause($param, {wrap => $opt{wrap}});

  # Where
  my $where;
  if (defined $opt{id}) {
    $where = $self->_id_to_param($opt{id}, $opt{primary_key}, $opt{table}) ;
  }
  else {
    $where = $opt{where};
  }

  my $w = $self->_where_clause_and_param($where);

  # Merge update parameter with where parameter
  $param = $self->merge_param($param, $w->{param});

  # Update statement
  my $sql = "update ";
  $sql .= "$opt{prefix} " if defined $opt{prefix};
  $sql .= $self->_tq($opt{table}) . " set $assign_clause $w->{clause} ";

  # Execute query
  $self->execute($sql, $param, %opt);
}

sub update_all { shift->update(@_, allow_update_all => 1) };

sub values_clause {
  my ($self, $param, $opts) = @_;

  my $wrap = $opts->{wrap} || {};

  # Create insert parameter tag
  my ($q, $p) = $self->_qp;

  my $safety_character = $self->safety_character;

  my @columns;
  my @place_holders;
  for my $column (sort keys %$param) {
    confess qq{"$column" is not safety column name in values clause} . _subname
      unless $column =~ /^[$safety_character\.]+$/;

    push @columns, "$q$column$p";
    push @place_holders, ref $param->{$column} eq 'SCALAR' ? ${$param->{$column}} :
      $wrap->{$column} ? $wrap->{$column}->(":$column") :
      ":$column";
  }

  my $values_clause = '(' . join(', ', @columns) . ') values (' . join(', ', @place_holders) . ')';

  return $values_clause;
}

sub assign_clause {
  my ($self, $param, $opts) = @_;

  my $wrap = $opts->{wrap} || {};
  my ($q, $p) = $self->_qp;

  my $safety_character = $self->safety_character;

  my @set_values;
  for my $column (sort keys %$param) {
    confess qq{"$column" is not safety column name in assign clause} . _subname
      unless $column =~ /^[$safety_character\.]+$/;

    push @set_values, ref $param->{$column} eq 'SCALAR' ? "$q$column$p = " . ${$param->{$column}}
      : $wrap->{$column} ? "$q$column$p = " . $wrap->{$column}->(":$column")
      : "$q$column$p = :$column";
  }

  my $assign_clause = join(', ', @set_values);

  return $assign_clause;
}

sub where { DBIx::Custom::Where->new(dbi => shift, @_) }

sub type_rule {
  my $self = shift;

  $self->{_type_rule_is_called} = 1;

  if (@_) {
    my $type_rule = ref $_[0] eq 'HASH' ? $_[0] : {@_};

    # Into
    for my $i (1 .. 2) {
      my $into = "into$i";
      my $exists_into = exists $type_rule->{$into};
      $type_rule->{$into} = _array_to_hash($type_rule->{$into});
      $self->{type_rule} = $type_rule;
      $self->{"_$into"} = {};
      for my $type_name (keys %{$type_rule->{$into} || {}}) {
        confess qq{type name of $into section must be lower case}
          if $type_name =~ /[A-Z]/;
      }

      $self->each_column(sub {
        my ($dbi, $table, $column, $column_info) = @_;

        my $type_name = lc $column_info->{TYPE_NAME};
        if ($type_rule->{$into} &&
            (my $filter = $type_rule->{$into}->{$type_name}))
        {
          return unless exists $type_rule->{$into}->{$type_name};
          if (defined $filter && ref $filter ne 'CODE')
          {
            my $fname = $filter;
            confess qq{Filter "$fname" is not registered" } . _subname
              unless exists $self->filters->{$fname};

            $filter = $self->filters->{$fname};
          }

          my $schema = $column_info->{TABLE_SCHEM};
          $self->{"_$into"}{key}{$table}{$column} = $filter;
          $self->{"_$into"}{dot}{"$table.$column"} = $filter;

          $self->{"_$into"}{key}{"$schema.$table"}{$column} = $filter;
          $self->{"_$into"}{dot}{"$schema.$table.$column"} = $filter;
        }
      });
    }

    # From
    for my $i (1 .. 2) {
      $type_rule->{"from$i"} = _array_to_hash($type_rule->{"from$i"});
      for my $data_type (keys %{$type_rule->{"from$i"} || {}}) {
        confess qq{data type of from$i section must be lower case or number}
          if $data_type =~ /[A-Z]/;
        my $fname = $type_rule->{"from$i"}{$data_type};
        if (defined $fname && ref $fname ne 'CODE') {
          confess qq{Filter "$fname" is not registered" } . _subname
            unless exists $self->filters->{$fname};

          $type_rule->{"from$i"}{$data_type} = $self->filters->{$fname};
        }
      }
    }

    return $self;
  }

  return $self->{type_rule} || {};
}

sub get_table_info {
  my ($self, %opt) = @_;

  my $exclude = delete $opt{exclude};
  confess qq/"$_" is wrong option/ for keys %opt;

  my $table_info = [];
  $self->each_table(
    sub { push @$table_info, {table => $_[1], info => $_[2] } },
    exclude => $exclude
  );

  return [sort {$a->{table} cmp $b->{table} } @$table_info];
}

sub get_column_info {
  my ($self, %opt) = @_;

  my $exclude_table = delete $opt{exclude_table};
  confess qq/"$_" is wrong option/ for keys %opt;

  my $column_info = [];
  $self->each_column(
    sub { push @$column_info, {table => $_[1], column => $_[2], info => $_[3] } },
    exclude_table => $exclude_table
  );

  return [
    sort {$a->{table} cmp $b->{table} || $a->{column} cmp $b->{column} }
      @$column_info];
}

sub each_column {
  my ($self, $cb, %options) = @_;

  my $user_column_info = $self->user_column_info;

  if ($user_column_info) {
    $self->$cb($_->{table}, $_->{column}, $_->{info}) for @$user_column_info;
  }
  else {
    my $re = $self->exclude_table || $options{exclude_table};
    # Tables
    my $tables = {};
    $self->each_table(sub {
      my ($dbi, $table, $table_info) = @_;
      my $schema = $table_info->{TABLE_SCHEM};
      $tables->{$schema}{$table}++;
    });

    # Iterate all tables
    for my $schema (sort keys %$tables) {
      for my $table (sort keys %{$tables->{$schema}}) {

        # Iterate all columns
        my $sth_columns;
        eval {$sth_columns = $self->dbh->column_info(undef, $schema, $table, '%')};
        next if $@;
        while (my $column_info = $sth_columns->fetchrow_hashref) {
          my $column = $column_info->{COLUMN_NAME};
          $self->$cb($table, $column, $column_info);
        }
      }
    }
  }
}

sub get_columns_from_db {
  my ($self, $schema_table, $opt) = @_;

  $opt ||= {};

  my $column_name_lc = $opt->{column_name_lc};

  my $schema;
  my $table;
  if ($schema_table =~ /^(.+)\.(.*)$/) {
    $schema = $1;
    $table = $2;
  }
  else {
    $schema = undef;
    $table = $schema_table;
  }

  my $sth_columns;
  eval {$sth_columns = $self->dbh->column_info(undef, $schema, $table, "%") };
  if ($@) {
    return;
  }

  my $columns;
  while (my $column_info = $sth_columns->fetchrow_hashref) {
    $columns ||= [];
    my $column = $column_info->{COLUMN_NAME};
    if ($column_name_lc) {
      $column = lc $column;
    }
    push @$columns, $column;
  }

  return $columns;
}

sub each_table {
  my ($self, $cb, %option) = @_;

  my $user_table_infos = $self->user_table_info;

  # Iterate tables
  if ($user_table_infos) {
      $self->$cb($_->{table}, $_->{info}) for @$user_table_infos;
  }
  else {
    my $re = $self->exclude_table || $option{exclude};
    my $sth_tables = $self->dbh->table_info;
    while (my $table_info = $sth_tables->fetchrow_hashref) {
      # Table
      my $table = $table_info->{TABLE_NAME};
      next if defined $re && $table =~ /$re/;
      $self->$cb($table, $table_info);
    }
  }
}

sub available_datatype {
  my $self = shift;

  my $data_types = '';
  for my $i (-1000 .. 1000) {
     my $type_info = $self->dbh->type_info($i);
     my $data_type = $type_info->{DATA_TYPE};
     my $type_name = $type_info->{TYPE_NAME};
     $data_types .= "$data_type ($type_name)\n"
       if defined $data_type;
  }
  return "Data Type maybe equal to Type Name" unless $data_types;
  $data_types = "Data Type (Type name)\n" . $data_types;
  return $data_types;
}

sub available_typename {
  my $self = shift;

  # Type Names
  my $type_names = {};
  $self->each_column(sub {
    my ($self, $table, $column, $column_info) = @_;
    $type_names->{$column_info->{TYPE_NAME}} = 1
      if $column_info->{TYPE_NAME};
  });
  my @output = sort keys %$type_names;
  unshift @output, "Type Name";
  return join "\n", @output;
}

sub show_datatype {
  my ($self, $table) = @_;
  confess "Table name must be specified" unless defined $table;
  print "$table\n";

  my $result = $self->select(table => $table, where => "'0' <> '0'");
  my $sth = $result->sth;

  my $columns = $sth->{NAME};
  my $data_types = $sth->{TYPE};

  for (my $i = 0; $i < @$columns; $i++) {
    my $column = $columns->[$i];
    my $data_type = lc $data_types->[$i];
    print "$column: $data_type\n";
  }
}

sub show_typename {
  my ($self, $t) = @_;
  confess "Table name must be specified" unless defined $t;
  print "$t\n";

  $self->each_column(sub {
    my ($self, $table, $column, $infos) = @_;
    return unless $table eq $t;
    my $typename = lc $infos->{TYPE_NAME};
    print "$column: $typename\n";
  });

  return $self;
}

sub show_tables {
  my $self = shift;

  my %tables;
  $self->each_table(sub { $tables{$_[1]}++ });
  print join("\n", sort keys %tables) . "\n";
  return $self;
}

sub _qp {
  my ($self, %opt) = @_;

  my $quote = $self->{quote} || $self->quote || '';

  my $q = substr($quote, 0, 1) || '';
  my $p;
  if (defined $quote && length $quote > 1) {
    $p = substr($quote, 1, 1);
  }
  else { $p = $q }

  if ($opt{quotemeta}) {
    $q = quotemeta($q);
    $p = quotemeta($p);
  }

  return ($q, $p);
}

sub _multi_values_clause {
  my ($self, $params, $opts) = @_;

  my $wrap = $opts->{wrap} || {};

  # Create insert parameter tag
  my ($q, $p) = $self->_qp;

  my $safety_character = $self->safety_character;

  my $first_param = $params->[0];

  my @columns;
  my @columns_quoted;
  for my $column (keys %$first_param) {
    confess qq{"$column" is not safety column name in multi values clause} . _subname
      unless $column =~ /^[$safety_character\.]+$/;

    push @columns, $column;
    push @columns_quoted, "$q$column$p";
  }

  # Multi values clause
  my $multi_values_clause = '(' . join(', ', @columns_quoted) . ') values ';

  for my $param (@$params) {
    my @place_holders;
    for my $column (@columns) {
      push @place_holders, ref $param->{$column} eq 'SCALAR' ? ${$param->{$column}} :
        $wrap->{$column} ? $wrap->{$column}->(":$column") :
        ":$column";
    }
    $multi_values_clause .= '(' . join(', ', @place_holders) . '), ';
  }
  $multi_values_clause =~ s/, $//;

  return $multi_values_clause;
}

sub _id_to_param {
  my ($self, $id, $primary_keys, $table) = @_;

  # Check primary key
  confess "primary_key option " .
        "must be specified when id option is used" . _subname
    unless defined $primary_keys;
  $primary_keys = [$primary_keys] unless ref $primary_keys eq 'ARRAY';

  _deprecate('0.39', "DBIx::Custom::select,update,delete method's id and primary_key option is DEPRECATED!");

  # Create parameter
  my $param = {};
  if (defined $id) {
    $id = [$id] unless ref $id eq 'ARRAY';
    for(my $i = 0; $i < @$id; $i++) {
      my $key = $primary_keys->[$i];
      $key = "$table." . $key if $table;
      $param->{$key} = $id->[$i];
    }
  }

  return $param;
}

sub _connect {
  my $self = shift;

  # Attributes
  my $dsn = $self->dsn;
  confess qq{"dsn" must be specified } . _subname
    unless $dsn;
  my $user        = $self->user;
  my $password    = $self->password;
  my $option = $self->option;
  $option = {%{$self->default_option}, %$option};

  # Connect
  my $dbh;
  eval { $dbh = DBI->connect($dsn, $user, $password, $option) };

  # Connect error
  confess "$@ " . _subname if $@;

  return $dbh;
}

sub _confess {
  my ($self, $error, $append) = @_;

  # Append
  $append ||= "";

  # Verbose
  if ($Carp::Verbose) { confess $error }

  # Not verbose
  else {
    # Remove line and module information
    my $at_pos = rindex($error, ' at ');
    $error = substr($error, 0, $at_pos);
    $error =~ s/\s+$//;
    confess "$error$append";
  }
}

sub _driver { lc shift->{dbh}->{Driver}->{Name} }

sub _need_tables {
  my ($self, $tree, $need_tables, $tables) = @_;

  # Get needed tables
  for my $table (@$tables) {
    if ($tree->{$table}) {
      $need_tables->{$table} = 1;
      $self->_need_tables($tree, $need_tables, [$tree->{$table}{parent}])
    }
  }
}

sub _push_join {
  my ($self, $sql, $join, $join_tables) = @_;

  # Push join clause
  my $tree = {};
  for (my $i = 0; $i < @$join; $i++) {

    # Arrange
    my $join_clause;;
    my $option;
    if (ref $join->[$i] eq 'HASH') {
      $join_clause = $join->[$i]->{clause};
      $option = {table => $join->[$i]->{table}};
    }
    else {
      $join_clause = $join->[$i];
      $option = {};
    };

    # Find tables in join clause
    my $table1;
    my $table2;
    if (my $table = $option->{table}) {
      $table1 = $table->[0];
      $table2 = $table->[1];
    }
    else {
      my $q = $self->_quote;
      my $j_clause = (split /\s+on\s+/, $join_clause)[-1];
      $j_clause =~ s/'.+?'//g;
      my $q_re = quotemeta($q);
      $j_clause =~ s/[$q_re]//g;

      my @j_clauses = reverse split /\s(and|on)\s/, $j_clause;
      my $c = $self->{safety_character};
      my $join_re = qr/((?:[$c]+?\.[$c]+?)|(?:[$c]+?))\.[$c]+[^$c].*?((?:[$c]+?\.[$c]+?)|(?:[$c]+?))\.[$c]+/sm;
      for my $clause (@j_clauses) {
        if ($clause =~ $join_re) {
          $table1 = $1;
          $table2 = $2;
          last;
        }
      }
    }
    confess qq{join clause must have two table name after "on" keyword. } .
        qq{"$join_clause" is passed }  . _subname
      unless defined $table1 && defined $table2;
    confess qq{right side table of "$join_clause" must be unique } . _subname
      if exists $tree->{$table2};
    confess qq{Same table "$table1" is specified} . _subname
      if $table1 eq $table2;
    $tree->{$table2}
      = {position => $i, parent => $table1, join => $join_clause};
  }

  # Search need tables
  my $need_tables = {};
  $self->_need_tables($tree, $need_tables, $join_tables);
  my @need_tables = sort { $tree->{$a}{position} <=> $tree->{$b}{position} }
    keys %$need_tables;

  # Add join clause
  $$sql .= $tree->{$_}{join} . ' ' for @need_tables;
}

sub _quote {
  my $self = shift;
  return $self->quote || '';
}

sub _remove_duplicate_table {
  my ($self, $tables, $main_table) = @_;

  # Remove duplicate table
  my %tables = map {defined $_ ? ($_ => 1) : ()} @$tables;
  delete $tables{$main_table} if $main_table;

  my $new_tables = [keys %tables, $main_table ? $main_table : ()];
  if (my $q = $self->_quote) {
    $q = quotemeta($q);
    $_ =~ s/[$q]//g for @$new_tables;
  }

  return $new_tables;
}

sub _search_tables {
  my ($self, $source) = @_;

  # Search tables
  my $tables = [];
  my ($q, $p) = $self->_qp(quotemeta => 1);
  $source =~ s/$q//g;
  $source =~ s/$p//g;
  my $c = $self->safety_character;

  while ($source =~ /((?:[$c]+?\.[$c]+?)|(?:[$c]+?))\.[$c]+/g) {
    push @$tables, $1;
  }
  return $tables;
}

sub _where_clause_and_param {
  my ($self, $where) = @_;

  $where ||= {};
  my $w = {};

  if (ref $where eq 'HASH') {
    my $safety_character = $self->safety_character;

    my $clause = [];
    my $column_join = '';
    for my $column (sort keys %$where) {

      confess qq{"$column" is not safety column name in where clause} . _subname
        unless $column =~ /^[$safety_character\.]+$/;

      $column_join .= $column;
      my $table;
      my $c;
      if ($column =~ /(?:(.*)\.)?(.*)/) {
        $table = $1;
        $c = $2;
      }

      my $table_quote;
      $table_quote = $self->_tq($table) if defined $table;
      my $column_quote = $self->q($c);
      $column_quote = $table_quote . '.' . $column_quote
        if defined $table_quote;
      if (ref $where->{$column} eq 'ARRAY') {
        my $c = join(', ', (":$column") x @{$where->{$column}});
        if (@{$where->{$column}}) {
          push @$clause, "$column_quote in ( $c )";
        }
        else { push @$clause, '1 <> 1' }
      }
      else { push @$clause, "$column_quote = :$column" }
    }

    $w->{clause} = @$clause ? "where ( " . join(' and ', @$clause) . " ) " : '' ;
    $w->{param} = $where;
  }
  elsif (ref $where) {
    my $obj;

    if (ref $where eq 'DBIx::Custom::Where') { $obj = $where }
    elsif (ref $where eq 'ARRAY') {
      $obj = $self->where(clause => $where->[0], param => $where->[1], join => $where->[2]);
    }

    # Check where argument
    confess qq{"where" must be hash reference or DBIx::Custom::Where object}
        . qq{or array reference, which contains where clause and parameter}
        . _subname
      unless ref $obj eq 'DBIx::Custom::Where';

    $w->{clause} = $obj->to_string;
    $w->{param} = $obj->param;
    $w->{join} = $obj->{join};
  }
  elsif ($where) {
    $w->{clause} = "where $where";
  }

  return $w;
}

# DEPRECATED
our $AUTOLOAD;
sub AUTOLOAD {
  my $self = shift;

  _deprecate('0.39', "DBIx::Custom AUTOLOAD feature is DEPRECATED!");

  # Method name
  my ($package, $mname) = $AUTOLOAD =~ /^([\w\:]+)\:\:(\w+)$/;

  # Call method
  $self->{_methods} ||= {};
  if (my $method = $self->{_methods}->{$mname}) {
    return $self->$method(@_)
  }
  elsif ($self->{dbh} && (my $dbh_method = $self->dbh->can($mname))) {
    $self->dbh->$dbh_method(@_);
  }
  else {
    confess qq{Can't locate object method "$mname" via "$package" }
      . _subname;
  }
}
sub DESTROY {}

# DEPRECATED
sub helper {
  my $self = shift;

  _deprecate('0.39', "DBIx::Custom::helper method is DEPRECATED!");

  # Register method
  my $methods = ref $_[0] eq 'HASH' ? $_[0] : {@_};
  $self->{_methods} = {%{$self->{_methods} || {}}, %$methods};

  return $self;
}

# DEPRECATED
sub update_or_insert {

  _deprecate('0.39', "DBIx::Custom::update_or_insert method is DEPRECATED!");

  my ($self, $param, %opt) = @_;
  confess "update_or_insert method need primary_key and id option "
    unless defined $opt{id} && defined $opt{primary_key};
  my $statement_opt = $opt{option} || {};

  my $rows = $self->select(%opt, %{$statement_opt->{select} || {}})->all;
  if (@$rows == 0) {
    return $self->insert($param, %opt, %{$statement_opt->{insert} || {}});
  }
  elsif (@$rows == 1) {
    return 0 unless keys %$param;
    return $self->update($param, %opt, %{$statement_opt->{update} || {}});
  }
  else { confess "selected row must be one " . _subname }
}

# DEPRECATED
sub count {
  _deprecate('0.39', "DBIx::Custom::count method is DEPRECATED!");
  shift->select(column => 'count(*)', @_)->fetch_one->[0]
}

1;

=head1 NAME

DBIx::Custom - DBI extension to execute insert, update, delete, and select easily

=head1 SYNOPSIS

  use DBIx::Custom;

  # Connect
  my $dbi = DBIx::Custom->connect(
    "dbi:mysql:database=dbname",
    'ken',
    '!LFKD%$&',
    {mysql_enable_utf8 => 1}
  );

  # Create model
  $dbi->create_model('book');

  # Insert
  $dbi->model('book')->insert({title => 'Perl', author => 'Ken'});

  # Update
  $dbi->model('book')->update({title => 'Perl', author => 'Ken'}, where  => {id => 5});

  # Delete
  $dbi->model('book')->delete(where => {author => 'Ken'});

  # Select
  my $result = $dbi->model('book')->select(['title', 'author'], where  => {author => 'Ken'});

  # Select, more complex
  #   select book.title as book.title,
  #     book.author as book.author,
  #     comnapy.name as company.name
  #   form book
  #     left outer join company on book.company_id = company.id
  #   where book.author = ?
  #   order by id limit 0, 5
  my $result = $dbi->model('book')->select(
    [
      {book => [qw/title author/]},
      {company => ['name']}
    ],
    where  => {'book.author' => 'Ken'},
    join => ['left outer join company on book.company_id = company.id'],
    append => 'order by id limit 0, 5'
  );

  # Get all rows or only one row
  my $rows = $result->all;
  my $row = $result->one;

  # Execute SQL with named place holder
  my $result = $dbi->execute(
    "select id from book where author = :author and title like :title",
    {author => 'ken', title => '%Perl%'}
  );

=head1 DESCRIPTION

L is L wrapper module to execute SQL easily.
This module have the following features.

=over 4

=item *

Execute C, C, C, or C statement easily

=item *

Create C clause flexibly

=item *

Named place holder support

=item *

Model support

=item *

Connection manager support

=item *

Choice your favorite relational database management system,
C, C, C, C,
C, C, C or anything,

=item *

Filtering by data type or column name

=item *

Create C clause flexibly

=back

=head1 WEB SITE

L

=head1 DOCUMENTS

L

L

=head1 ATTRIBUTES

=head2 connector

  my $connector = $dbi->connector;
  $dbi = $dbi->connector($connector);

Connection manager object. if C is set, you can get C
through connection manager. Conection manager object must have C method.

This is L example. Please pass
C to L C method.

  my $connector = DBIx::Connector->new(
    "dbi:mysql:database=$database",
    $user,
    $password,
    DBIx::Custom->new->default_option
  );

  my $dbi = DBIx::Custom->connect(connector => $connector);

If C is set to 1 when connect method is called,
L is automatically set to C

  my $dbi = DBIx::Custom->connect(
    dsn => $dsn, user => $user, password => $password, connector => 1);

  my $connector = $dbi->connector; # DBIx::Connector

Note that L must be installed.

=head2 dsn

  my $dsn = $dbi->dsn;
  $dbi = $dbi->dsn("DBI:mysql:database=dbname");

Data source name, used when C method is executed.

=head2 default_option

  my $default_option = $dbi->default_option;
  $dbi = $dbi->default_option($default_option);

L default option, used when C method is executed,
default to the following values.

  {
    RaiseError => 1,
    PrintError => 0,
    AutoCommit => 1,
  }

=head2 exclude_table

  my $exclude_table = $dbi->exclude_table;
  $dbi = $dbi->exclude_table(qr/pg_/);

Excluded table regex.
C, C, C

=head2 filters

  my $filters = $dbi->filters;
  $dbi = $dbi->filters(\%filters);

Filters, registered by C method.

=head2 last_sql

  my $last_sql = $dbi->last_sql;
  $dbi = $dbi->last_sql($last_sql);

Get last succeeded SQL executed by C method.

=head2 now

  my $now = $dbi->now;
  $dbi = $dbi->now($now);

Code reference which return current time, default to the following code reference.

  sub {
    my ($sec, $min, $hour, $mday, $mon, $year) = localtime;
    $mon++;
    $year += 1900;
    return sprintf("%04d-%02d-%02d %02d:%02d:%02d");
  }

This return the time like C<2011-10-14 05:05:27>.

This is used by C method's C option and C option,
and C method's C option.

=head2 models

  my $models = $dbi->models;
  $dbi = $dbi->models(\%models);

Models, included by C method.

=head2 mytable_symbol

Symbol to specify own columns in select method column option, default to '__MY__'.

  $dbi->table('book')->select({__MY__ => '*'});

=head2 option

  my $option = $dbi->option;
  $dbi = $dbi->option($option);

L option, used when C method is executed.
Each value in option override the value of C.

=head2 password

  my $password = $dbi->password;
  $dbi = $dbi->password('lkj&le`@s');

Password, used when C method is executed.

=head2 quote

  my quote = $dbi->quote;
  $dbi = $dbi->quote('"');

Reserved word quote.
Default to double quote '"' except for mysql.
In mysql, default to back quote '`'

You can set quote pair.

  $dbi->quote('[]');

=head2 result_class

  my $result_class = $dbi->result_class;
  $dbi = $dbi->result_class('DBIx::Custom::Result');

Result class, default to L.

=head2 safety_character

  my $safety_character = $dbi->safety_character;
  $dbi = $dbi->safety_character($character);

Regex of safety character for table and column name, default to 'a-zA-Z_'.
Note that you don't have to specify like '[a-zA-Z_]'.

=head2 separator

  my $separator = $dbi->separator;
  $dbi = $dbi->separator('-');

Separator which join table name and column name.
This have effect to C and C method,
and C method's column option.

Default to C<.>.

=head2 user

  my $user = $dbi->user;
  $dbi = $dbi->user('Ken');

User name, used when C method is executed.

=head2 user_column_info

  my $user_column_info = $dbi->user_column_info;
  $dbi = $dbi->user_column_info($user_column_info);

You can set the date like the following one.

  [
    {table => 'book', column => 'title', info => {...}},
    {table => 'author', column => 'name', info => {...}}
  ]

Usually, you set return value of C.

  my $user_column_info
    = $dbi->get_column_info(exclude_table => qr/^system/);
  $dbi->user_column_info($user_column_info);

If C is set, C use C
to find column info. this is very fast.

=head2 user_table_info

  my $user_table_info = $dbi->user_table_info;
  $dbi = $dbi->user_table_info($user_table_info);

You can set the following data.

  [
    {table => 'book', info => {...}},
    {table => 'author', info => {...}}
  ]

Usually, you can set return value of C.

  my $user_table_info = $dbi->get_table_info(exclude => qr/^system/);
  $dbi->user_table_info($user_table_info);

If C is set, C use C
to find table info.

=head1 METHODS

L inherits all methods from L
and use all methods of L
and implements the following new ones.

=head2 available_datatype

  print $dbi->available_datatype;

Get available data types. You can use these data types
in C's C and C section.

=head2 available_typename

  print $dbi->available_typename;

Get available type names. You can use these type names in
C's C and C section.

=head2 assign_clause

  my $assign_clause = $dbi->assign_clause({title => 'a', age => 2});

Create assign clause

  title = :title, author = :author

This is used to create update clause.

  "update book set " . $dbi->assign_clause({title => 'a', age => 2});

=head2 column

  my $column = $dbi->column(book => ['author', 'title']);

Create column clause. The following column clause is created.

  book.author as "book.author",
  book.title as "book.title"

You can change separator by C attribute.

  # Separator is hyphen
  $dbi->separator('-');

  book.author as "book-author",
  book.title as "book-title"

=head2 connect

  # DBI compatible arguments
  my $dbi = DBIx::Custom->connect(
    "dbi:mysql:database=dbname",
    'ken',
    '!LFKD%$&',
    {mysql_enable_utf8 => 1}
  );

  # pass DBIx::Custom attributes
  my $dbi = DBIx::Custom->connect(
    dsn => "dbi:mysql:database=dbname",
    user => 'ken',
    password => '!LFKD%$&',
    option => {mysql_enable_utf8 => 1}
  );

Connect to the database and create a new L object.

L is a wrapper of L.
C and C options are true,
and C option is false by default.

=head2 create_model

  $dbi->create_model('book');
  $dbi->create_model(
    'book',
    join => [
      'inner join company on book.comparny_id = company.id'
    ]
  );
  $dbi->create_model(
    table => 'book',
    join => [
      'inner join company on book.comparny_id = company.id'
    ],
  );

Create L object and initialize model.
Model columns attribute is automatically set.
You can use this model by using C method.

  $dbi->model('book')->select(...);

You can use model name which different from table name

  $dbi->create_model(name => 'book1', table => 'book');
  $dbi->model('book1')->select(...);

  $dbi->create_model(
    table => 'book',
    join => [
      'inner join company on book.comparny_id = company.id'
    ],
  );

C option change column names to lower case.

  $dbi->create_model(
    table => 'book',
    join => [
      'inner join company on book.comparny_id = company.id'
    ],
    column_name_lc => 1,
  );

=head2 dbh

  my $dbh = $dbi->dbh;

Get L database handle. if C is set, you can get
database handle through C object.

=head2 delete

  $dbi->delete(table => 'book', where => {title => 'Perl'});

Execute delete statement.

The following options are available.

B

C method use all of C method's options,
and use the following new ones.

=over 4

=item prefix

  prefix => 'some'

prefix before table name section.

  delete some from book

=item table

  table => 'book'

Table name.

=item where

Same as C method's C option.

=back

=head2 delete_all

  $dbi->delete_all(table => $table);

Execute delete statement for all rows.
Options is same as C.

=head2 each_column

  $dbi->each_column(
    sub {
      my ($dbi, $table, $column, $column_info) = @_;

      my $type = $column_info->{TYPE_NAME};

      if ($type eq 'DATE') {
          # ...
      }
    }
  );

Iterate all column informations in database.
Argument is callback which is executed when one column is found.
Callback receive four arguments. C, C, 




2058




 





 





 





 





 





 



 C, and C. 




2059




 





 





 





 





 





 



   




2060




 





 





 





 





 





 



 If C is set, C method use C 




2061




 





 





 





 





 





 



 information, you can improve the performance of C in 




2062




 





 





 





 





 





 



 the following way. 




2063




 





 





 





 





 





 



   




2064




 





 





 





 





 





 



   my $column_infos = $dbi->get_column_info(exclude_table => qr/^system_/); 




2065




 





 





 





 





 





 



   $dbi->user_column_info($column_info); 




2066




 





 





 





 





 





 



   $dbi->each_column(sub { ... }); 




2067




 





 





 





 





 





 



   




2068




 





 





 





 





 





 



 =head2 each_table 




2069




 





 





 





 





 





 



   




2070




 





 





 





 





 





 



   $dbi->each_table( 




2071




 





 





 





 





 





 



     sub { 




2072




 





 





 





 





 





 



       my ($dbi, $table, $table_info) = @_; 




2073




 





 





 





 





 





 



        




2074




 





 





 





 





 





 



       my $table_name = $table_info->{TABLE_NAME}; 




2075




 





 





 





 





 





 



     } 




2076




 





 





 





 





 





 



   ); 




2077




 





 





 





 





 





 



   




2078




 





 





 





 





 





 



 Iterate all table information from in database. 




2079




 





 





 





 





 





 



 Argument is callback which is executed when one table is found. 




2080




 





 





 





 





 





 



 Callback receive three arguments, C, C, 




2081




 





 





 





 





 





 



 C. 




2082




 





 





 





 





 





 



   




2083




 





 





 





 





 





 



 If C is set, C method use C 




2084




 





 





 





 





 





 



 information, you can improve the performance of C in 




2085




 





 





 





 





 





 



 the following way. 




2086




 





 





 





 





 





 



   




2087




 





 





 





 





 





 



   my $table_infos = $dbi->get_table_info(exclude => qr/^system_/); 




2088




 





 





 





 





 





 



   $dbi->user_table_info($table_info); 




2089




 





 





 





 





 





 



   $dbi->each_table(sub { ... }); 




2090




 





 





 





 





 





 



   




2091




 





 





 





 





 





 



 =head2 execute 




2092




 





 





 





 





 





 



   




2093




 





 





 





 





 





 



   my $result = $dbi->execute( 




2094




 





 





 





 





 





 



     "select * from book where title = :title and author like :author", 




2095




 





 





 





 





 





 



     {title => 'Perl', author => '%Ken%'} 




2096




 





 





 





 





 





 



   ); 




2097




 





 





 





 





 





 



   




2098




 





 





 





 





 





 



   my $result = $dbi->execute( 




2099




 





 





 





 





 





 



     "select * from book where title = :book.title and author like :book.author", 




2100




 





 





 





 





 





 



     {'book.title' => 'Perl', 'book.author' => '%Ken%'} 




2101




 





 





 





 





 





 



   ); 




2102




 





 





 





 





 





 



   




2103




 





 





 





 





 





 



 Execute SQL. SQL can contain column parameter such as :author and :title. 




2104




 





 





 





 





 





 



 You can append table name to column name such as :book.title and :book.author. 




2105




 





 





 





 





 





 



 Second argument is data, embedded into column parameter. 




2106




 





 





 





 





 





 



 Return value is L object when select statement is executed, 




2107




 





 





 





 





 





 



 or the count of affected rows when insert, update, delete statement is executed. 




2108




 





 





 





 





 





 



   




2109




 





 





 





 





 





 



 Named placeholder such as C<:title> is replaced by placeholder C. 




2110




 





 





 





 





 





 



    




2111




 





 





 





 





 





 



   # Original 




2112




 





 





 





 





 





 



   select * from book where title = :title and author like :author 




2113




 





 





 





 





 





 



    




2114




 





 





 





 





 





 



   # Replaced 




2115




 





 





 





 





 





 



   select * from where title = ? and author like ?; 




2116




 





 





 





 





 





 



   




2117




 





 





 





 





 





 



 You can specify operator with named placeholder 




2118




 





 





 





 





 





 



 by C syntax. 




2119




 





 





 





 





 





 



   




2120




 





 





 





 





 





 



   # Original 




2121




 





 





 





 





 





 



   select * from book where :title{=} and :author{like} 




2122




 





 





 





 





 





 



    




2123




 





 





 





 





 





 



   # Replaced 




2124




 





 





 





 





 





 



   select * from where title = ? and author like ?; 




2125




 





 





 





 





 





 



   




2126




 





 





 





 





 





 



 Note that colons in time format such as 12:13:15 is an exception, 




2127




 





 





 





 





 





 



 it is not parsed as named placeholder. 




2128




 





 





 





 





 





 



 If you want to use colon generally, you must escape it by C<\\> 




2129




 





 





 





 





 





 



   




2130




 





 





 





 





 





 



   select * from where title = "aa\\:bb"; 




2131




 





 





 





 





 





 



   




2132




 





 





 





 





 





 



 B 




2133




 





 





 





 





 





 



   




2134




 





 





 





 





 





 



 The following options are available. 




2135




 





 





 





 





 





 



   




2136




 





 





 





 





 





 



 =over 4 




2137




 





 





 





 





 





 



   




2138




 





 





 





 





 





 



 =item after_build_sql  




2139




 





 





 





 





 





 



   




2140




 





 





 





 





 





 



 You can filter sql after the sql is build. 




2141




 





 





 





 





 





 



   




2142




 





 





 





 





 





 



   after_build_sql => $code_ref 




2143




 





 





 





 





 





 



   




2144




 





 





 





 





 





 



 The following one is one example. 




2145




 





 





 





 





 





 



   




2146




 





 





 





 





 





 



   $dbi->select( 




2147




 





 





 





 





 





 



     table => 'book', 




2148




 





 





 





 





 





 



     column => 'distinct(name)', 




2149




 





 





 





 





 





 



     after_build_sql => sub { 




2150




 





 





 





 





 





 



       "select count(*) from ($_[0]) as t1" 




2151




 





 





 





 





 





 



     } 




2152




 





 





 





 





 





 



   ); 




2153




 





 





 





 





 





 



   




2154




 





 





 





 





 





 



 The following SQL is executed. 




2155




 





 





 





 





 





 



   




2156




 





 





 





 





 





 



   select count(*) from (select distinct(name) from book) as t1; 




2157




 





 





 





 





 





 



   




2158




 





 





 





 





 





 



 =item append 




2159




 





 





 





 





 





 



   




2160




 





 





 





 





 





 



   append => 'order by name' 




2161




 





 





 





 





 





 



   




2162




 





 





 





 





 





 



 Append some statement after SQL. 




2163




 





 





 





 





 





 



   




2164




 





 





 





 





 





 



 =item bind_type 




2165




 





 





 





 





 





 



   




2166




 





 





 





 





 





 



 Specify database bind data type. 




2167




 





 





 





 





 





 



    




2168




 





 





 





 





 





 



   bind_type => {image => DBI::SQL_BLOB} 




2169




 





 





 





 





 





 



   bind_type => [image => DBI::SQL_BLOB] 




2170




 





 





 





 





 





 



   bind_type => [[qw/image audio/] => DBI::SQL_BLOB] 




2171




 





 





 





 





 





 



   




2172




 





 





 





 





 





 



 This is used to bind parameter by C of statement handle. 




2173




 





 





 





 





 





 



   




2174




 





 





 





 





 





 



   $sth->bind_param($pos, $value, DBI::SQL_BLOB); 




2175




 





 





 





 





 





 



   




2176




 





 





 





 





 





 



 =item filter 




2177




 





 





 





 





 





 



    




2178




 





 





 





 





 





 



   filter => { 




2179




 





 





 





 





 





 



     title  => sub { uc $_[0] } 




2180




 





 





 





 





 





 



     author => sub { uc $_[0] } 




2181




 





 





 





 





 





 



   } 




2182




 





 





 





 





 





 



   




2183




 





 





 





 





 





 



   # Filter name 




2184




 





 





 





 





 





 



   filter => { 




2185




 





 





 





 





 





 



     title  => 'upper_case', 




2186




 





 





 





 





 





 



     author => 'upper_case' 




2187




 





 





 





 





 





 



   } 




2188




 





 





 





 





 





 



        




2189




 





 





 





 





 





 



   # At once 




2190




 





 





 





 





 





 



   filter => [ 




2191




 





 





 





 





 





 



     [qw/title author/]  => sub { uc $_[0] } 




2192




 





 





 





 





 





 



   ] 




2193




 





 





 





 





 





 



   




2194




 





 





 





 





 





 



 Filter. You can set subroutine or filter name 




2195




 





 





 





 





 





 



 registered by C. 




2196




 





 





 





 





 





 



 This filter is executed before data is saved into database. 




2197




 





 





 





 





 





 



 and before type rule filter is executed. 




2198




 





 





 





 





 





 



   




2199




 





 





 





 





 





 



 =item reuse 




2200




 





 





 





 





 





 



    




2201




 





 





 





 





 





 



   reuse => $hash_ref 




2202




 





 





 





 





 





 



   




2203




 





 





 





 





 





 



 Reuse statement handle in same SQL. 




2204




 





 





 





 





 





 



    




2205




 





 





 





 





 





 



   my $reuse = {}; 




2206




 





 





 





 





 





 



   $dbi->execute($sql, $param, reuse => $reuse); 




2207




 





 





 





 





 





 



   




2208




 





 





 





 





 





 



 This will improved performance when you want to execute same sql repeatedly. 




2209




 





 





 





 





 





 



   




2210




 





 





 





 





 





 



 =item table 




2211




 





 





 





 





 





 



    




2212




 





 





 





 





 





 



   table => 'author' 




2213




 





 





 





 





 





 



   




2214




 





 





 





 





 





 



 If you want to omit table name in column name 




2215




 





 





 





 





 





 



 and enable C and C type filter, 




2216




 





 





 





 





 





 



 You must set C option. 




2217




 





 





 





 





 





 



   




2218




 





 





 





 





 





 



   $dbi->execute("select * from book where title = :title and author = :author", 




2219




 





 





 





 





 





 



     {title => 'Perl', author => 'Ken', table => 'book'); 




2220




 





 





 





 





 





 



   




2221




 





 





 





 





 





 



   # Same 




2222




 





 





 





 





 





 



   $dbi->execute( 




2223




 





 





 





 





 





 



     "select * from book where title = :book.title and author = :book.author", 




2224




 





 





 





 





 





 



     {title => 'Perl', author => 'Ken'); 




2225




 





 





 





 





 





 



   




2226




 





 





 





 





 





 



 =item table_alias 




2227




 





 





 





 





 





 



   




2228




 





 





 





 





 





 



   table_alias => {worker => 'user'} # {ALIAS => TABLE} 




2229




 





 





 





 





 





 



   




2230




 





 





 





 





 





 



 Table alias. Key is alias table name, value is real table name, . 




2231




 





 





 





 





 





 



 If you set C, you can enable C and C type rule 




2232




 





 





 





 





 





 



 on alias table name. 




2233




 





 





 





 





 





 



   




2234




 





 





 





 





 





 



 =item type_rule_off 




2235




 





 





 





 





 





 



   




2236




 





 





 





 





 





 



   type_rule_off => 1 




2237




 





 





 





 





 





 



   




2238




 





 





 





 





 





 



 Turn C and C type rule off. 




2239




 





 





 





 





 





 



   




2240




 





 





 





 





 





 



 =item type_rule1_off 




2241




 





 





 





 





 





 



   




2242




 





 





 





 





 





 



   type_rule1_off => 1 




2243




 





 





 





 





 





 



   




2244




 





 





 





 





 





 



 Turn C type rule off. 




2245




 





 





 





 





 





 



   




2246




 





 





 





 





 





 



 =item type_rule2_off 




2247




 





 





 





 





 





 



   




2248




 





 





 





 





 





 



   type_rule2_off => 1 




2249




 





 





 





 





 





 



   




2250




 





 





 





 





 





 



 Turn C type rule off. 




2251




 





 





 





 





 





 



   




2252




 





 





 





 





 





 



 =item prepare_attr 




2253




 





 





 





 





 





 



   




2254




 





 





 





 





 





 



   prepare_attr => {mysql_use_result => 1} 




2255




 





 





 





 





 





 



   




2256




 





 





 





 





 





 



 Statemend handle attributes, 




2257




 





 





 





 





 





 



 this is L's C method second argument. 




2258




 





 





 





 





 





 



   




2259




 





 





 





 





 





 



 =head2 get_column_info 




2260




 





 





 





 





 





 



   




2261




 





 





 





 





 





 



   my $column_infos = $dbi->get_column_info(exclude_table => qr/^system_/); 




2262




 





 





 





 





 





 



   




2263




 





 





 





 





 





 



 get column information except for one which match C pattern. 




2264




 





 





 





 





 





 



   




2265




 





 





 





 





 





 



   [ 




2266




 





 





 





 





 





 



     {table => 'book', column => 'title', info => {...}}, 




2267




 





 





 





 





 





 



     {table => 'author', column => 'name' info => {...}} 




2268




 





 





 





 





 





 



   ] 




2269




 





 





 





 





 





 



   




2270




 





 





 





 





 





 



 =head2 get_table_info 




2271




 





 





 





 





 





 



   




2272




 





 





 





 





 





 



   my $table_infos = $dbi->get_table_info(exclude => qr/^system_/); 




2273




 





 





 





 





 





 



   




2274




 





 





 





 





 





 



 get table information except for one which match C pattern. 




2275




 





 





 





 





 





 



   




2276




 





 





 





 





 





 



   [ 




2277




 





 





 





 





 





 



     {table => 'book', info => {...}}, 




2278




 





 





 





 





 





 



     {table => 'author', info => {...}} 




2279




 





 





 





 





 





 



   ] 




2280




 





 





 





 





 





 



   




2281




 





 





 





 





 





 



 You can set this value to C. 




2282




 





 





 





 





 





 



   




2283




 





 





 





 





 





 



 =head2 insert 




2284




 





 





 





 





 





 



   




2285




 





 





 





 





 





 



   $dbi->insert({title => 'Perl', author => 'Ken'}, table  => 'book'); 




2286




 





 





 





 





 





 



   




2287




 





 





 





 





 





 



 Execute insert statement. First argument is row data. Return value is 




2288




 





 





 





 





 





 



 affected row count. 




2289




 





 





 





 





 





 



   




2290




 





 





 





 





 





 



 If you want to set constant value to row data, use scalar reference 




2291




 





 





 





 





 





 



 as parameter value. 




2292




 





 





 





 





 





 



   




2293




 





 





 





 





 





 



   {date => \"NOW()"} 




2294




 





 





 





 





 





 



   




2295




 





 





 





 





 





 



 You can pass multiple parameters, this is very fast. 




2296




 





 





 





 





 





 



   




2297




 





 





 





 





 





 



   $dbi->insert( 




2298




 





 





 





 





 





 



     [ 




2299




 





 





 





 





 





 



       {title => 'Perl', author => 'Ken'}, 




2300




 





 





 





 





 





 



       {title => 'Ruby', author => 'Tom'} 




2301




 





 





 





 





 





 



     ], 




2302




 





 





 





 





 





 



     table  => 'book' 




2303




 





 





 





 





 





 



   ); 




2304




 





 





 





 





 





 



   




2305




 





 





 





 





 





 



 In multiple insert, you can't use C option. 




2306




 





 





 





 





 





 



 and only first parameter is used to create sql. 




2307




 





 





 





 





 





 



   




2308




 





 





 





 





 





 



 B 




2309




 





 





 





 





 





 



   




2310




 





 





 





 





 





 



 C method use all of C method's options, 




2311




 





 





 





 





 





 



 and use the following new ones. 




2312




 





 





 





 





 





 



   




2313




 





 





 





 





 





 



 =over 4 




2314




 





 





 





 





 





 



   




2315




 





 





 





 





 





 



 =item bulk_insert 




2316




 





 





 





 





 





 



   




2317




 





 





 





 





 





 



   bulk_insert => 1 




2318




 





 





 





 





 





 



   




2319




 





 





 





 





 





 



 bulk insert is executed if database support bulk insert and  




2320




 





 





 





 





 





 



 multiple parameters is passed to C. 




2321




 





 





 





 





 





 



 The SQL like the following one is executed. 




2322




 





 





 





 





 





 



   




2323




 





 





 





 





 





 



   insert into book (id, title) values (?, ?), (?, ?); 




2324




 





 





 





 





 





 



   




2325




 





 





 





 





 





 



 =item ctime 




2326




 





 





 





 





 





 



   




2327




 





 





 





 





 





 



   ctime => 'created_time' 




2328




 





 





 





 





 





 



   




2329




 





 





 





 





 





 



 Created time column name. time when row is created is set to the column. 




2330




 





 





 





 





 





 



 default time format is "YYYY-mm-dd HH:MM:SS", which can be changed by 




2331




 





 





 





 





 





 



 C attribute. 




2332




 





 





 





 





 





 



   




2333




 





 





 





 





 





 



 =item prefix 




2334




 





 





 





 





 





 



   




2335




 





 





 





 





 





 



   prefix => 'or replace' 




2336




 





 





 





 





 





 



   




2337




 





 





 





 





 





 



 prefix before table name section 




2338




 





 





 





 





 





 



   




2339




 





 





 





 





 





 



   insert or replace into book 




2340




 





 





 





 





 





 



   




2341




 





 





 





 





 





 



 =item table 




2342




 





 





 





 





 





 



   




2343




 





 





 





 





 





 



   table => 'book' 




2344




 





 





 





 





 





 



   




2345




 





 





 





 





 





 



 Table name. 




2346




 





 





 





 





 





 



   




2347




 





 





 





 





 





 



 =item mtime 




2348




 





 





 





 





 





 



   




2349




 





 





 





 





 





 



 This option is same as C method C option. 




2350




 





 





 





 





 





 



   




2351




 





 





 





 





 





 



 =item wrap 




2352




 





 





 





 





 





 



   




2353




 





 





 





 





 





 



   wrap => {price => sub { "max($_[0])" }} 




2354




 





 





 





 





 





 



   




2355




 





 





 





 





 





 



 placeholder wrapped string. 




2356




 





 





 





 





 





 



   




2357




 





 





 





 





 





 



 If the following statement 




2358




 





 





 





 





 





 



   




2359




 





 





 





 





 





 



   $dbi->insert({price => 100}, table => 'book', 




2360




 





 





 





 





 





 



     {price => sub { "$_[0] + 5" }}); 




2361




 





 





 





 





 





 



   




2362




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2363




 





 





 





 





 





 



   




2364




 





 





 





 





 





 



   insert into book price values ( ? + 5 ); 




2365




 





 





 





 





 





 



   




2366




 





 





 





 





 





 



 =back 




2367




 





 





 





 





 





 



   




2368




 





 





 





 





 





 



 =over 4 




2369




 





 





 





 





 





 



   




2370




 





 





 





 





 





 



 =head2 include_model 




2371




 





 





 





 





 





 



   




2372




 





 





 





 





 





 



   $dbi->include_model('MyModel'); 




2373




 





 





 





 





 





 



   




2374




 





 





 





 





 





 



 Include models from specified namespace, 




2375




 





 





 





 





 





 



 the following layout is needed to include models. 




2376




 





 





 





 





 





 



   




2377




 





 





 





 





 





 



   lib / MyModel.pm 




2378




 





 





 





 





 





 



       / MyModel / book.pm 




2379




 





 





 





 





 





 



                 / company.pm 




2380




 





 





 





 





 





 



   




2381




 





 





 





 





 





 



 Name space module, extending L. 




2382




 





 





 





 





 





 



   




2383




 





 





 





 





 





 



 B 




2384




 





 





 





 





 





 



   




2385




 





 





 





 





 





 



   package MyModel; 




2386




 





 





 





 





 





 



   use DBIx::Custom::Model -base; 




2387




 





 





 





 





 





 



    




2388




 





 





 





 





 





 



   1; 




2389




 





 





 





 





 





 



   




2390




 





 





 





 





 





 



 Model modules, extending name space module. 




2391




 





 





 





 





 





 



   




2392




 





 





 





 





 





 



 B 




2393




 





 





 





 





 





 



   




2394




 





 





 





 





 





 



   package MyModel::book; 




2395




 





 





 





 





 





 



   use MyModel -base; 




2396




 





 





 





 





 





 



    




2397




 





 





 





 





 





 



   1; 




2398




 





 





 





 





 





 



   




2399




 





 





 





 





 





 



 B 




2400




 





 





 





 





 





 



   




2401




 





 





 





 





 





 



   package MyModel::company; 




2402




 





 





 





 





 





 



   use MyModel -base; 




2403




 





 





 





 





 





 



    




2404




 





 





 





 





 





 



   1; 




2405




 





 





 





 





 





 



    




2406




 





 





 





 





 





 



 MyModel::book and MyModel::company is included by C. 




2407




 





 





 





 





 





 



   




2408




 





 





 





 





 





 



 You can get model object by C. 




2409




 





 





 





 





 





 



   




2410




 





 





 





 





 





 



   my $book_model = $dbi->model('book'); 




2411




 





 





 





 





 





 



   my $company_model = $dbi->model('company'); 




2412




 





 





 





 





 





 



   




2413




 





 





 





 





 





 



 You can include full-qualified table name like C 




2414




 





 





 





 





 





 



   




2415




 





 





 





 





 





 



   lib / MyModel.pm 




2416




 





 





 





 





 





 



       / MyModel / main / book.pm 




2417




 





 





 





 





 





 



                        / company.pm 




2418




 





 





 





 





 





 



   




2419




 





 





 





 





 





 



   my $main_book = $self->model('main.book'); 




2420




 





 





 





 





 





 



   




2421




 





 





 





 





 





 



 See L to know model features. 




2422




 





 





 





 





 





 



   




2423




 





 





 





 





 





 



 =head2 like_value 




2424




 





 





 





 





 





 



   




2425




 





 





 





 





 





 



   my $like_value = $dbi->like_value 




2426




 





 





 





 





 





 



   




2427




 





 





 





 





 





 



 Code reference which return a value for the like value. 




2428




 





 





 





 





 





 



   




2429




 





 





 





 





 





 



   sub { "%$_[0]%" } 




2430




 





 





 





 





 





 



   




2431




 





 





 





 





 





 



 =head2 mapper 




2432




 





 





 





 





 





 



   




2433




 





 





 





 





 





 



   my $mapper = $dbi->mapper(param => $param); 




2434




 





 





 





 





 





 



   




2435




 





 





 





 





 





 



 Create a new L object. 




2436




 





 





 





 





 





 



   




2437




 





 





 





 





 





 



 =head2 merge_param 




2438




 





 





 





 





 





 



   




2439




 





 





 





 





 





 



   my $param = $dbi->merge_param({key1 => 1}, {key1 => 1, key2 => 2}); 




2440




 





 





 





 





 





 



   




2441




 





 





 





 





 





 



 Merge parameters. The following new parameter is created. 




2442




 





 





 





 





 





 



   




2443




 





 





 





 





 





 



   {key1 => [1, 1], key2 => 2} 




2444




 





 





 





 





 





 



   




2445




 





 





 





 





 





 



 If same keys contains, the value is converted to array reference. 




2446




 





 





 





 





 





 



   




2447




 





 





 





 





 





 



 =head2 model 




2448




 





 





 





 





 





 



   




2449




 





 





 





 





 





 



   my $model = $dbi->model('book'); 




2450




 





 





 





 





 





 



   




2451




 





 





 





 





 





 



 Get a L object 




2452




 





 





 





 





 





 



 create by C or C 




2453




 





 





 





 





 





 



   




2454




 





 





 





 





 





 



 =head2 mycolumn 




2455




 





 





 





 





 





 



   




2456




 





 





 





 





 





 



   my $column = $dbi->mycolumn(book => ['author', 'title']); 




2457




 





 





 





 





 





 



   




2458




 





 





 





 





 





 



 Create column clause for myself. The following column clause is created. 




2459




 





 





 





 





 





 



   




2460




 





 





 





 





 





 



   book.author as author, 




2461




 





 





 





 





 





 



   book.title as title 




2462




 





 





 





 





 





 



   




2463




 





 





 





 





 





 



 =head2 new 




2464




 





 





 





 





 





 



   




2465




 





 





 





 





 





 



   my $dbi = DBIx::Custom->new( 




2466




 





 





 





 





 





 



     dsn => "dbi:mysql:database=dbname", 




2467




 





 





 





 





 





 



     user => 'ken', 




2468




 





 





 





 





 





 



     password => '!LFKD%$&', 




2469




 





 





 





 





 





 



     option => {mysql_enable_utf8 => 1} 




2470




 





 





 





 





 





 



   ); 




2471




 





 





 





 





 





 



   




2472




 





 





 





 





 





 



 Create a new L object. 




2473




 





 





 





 





 





 



   




2474




 





 





 





 





 





 



 =head2 not_exists 




2475




 





 





 





 





 





 



   




2476




 





 





 





 





 





 



   my $not_exists = $dbi->not_exists; 




2477




 





 





 





 





 





 



   




2478




 





 





 





 





 





 



 DBIx::Custom::NotExists object, indicating the column is not exists. 




2479




 





 





 





 





 





 



 This is used in C of L . 




2480




 





 





 





 





 





 



   




2481




 





 





 





 





 





 



 =head2 order 




2482




 





 





 





 





 





 



   




2483




 





 





 





 





 





 



   my $order = $dbi->order; 




2484




 





 





 





 





 





 



   




2485




 





 





 





 





 





 



 Create a new L object. 




2486




 





 





 





 





 





 



   




2487




 





 





 





 





 





 



 =head2 q 




2488




 





 





 





 





 





 



   




2489




 





 





 





 





 





 



   my $quooted = $dbi->q("title"); 




2490




 





 





 





 





 





 



   




2491




 





 





 





 





 





 



 Quote string by value of C. 




2492




 





 





 





 





 





 



   




2493




 





 





 





 





 





 



 =head2 register_filter 




2494




 





 





 





 





 





 



   




2495




 





 





 





 





 





 



   $dbi->register_filter( 




2496




 





 





 





 





 





 



     # Time::Piece object to database DATE format 




2497




 





 





 





 





 





 



     tp_to_date => sub { 




2498




 





 





 





 





 





 



       my $tp = shift; 




2499




 





 





 





 





 





 



       return $tp->strftime('%Y-%m-%d'); 




2500




 





 





 





 





 





 



     }, 




2501




 





 





 





 





 





 



     # database DATE format to Time::Piece object 




2502




 





 





 





 





 





 



     date_to_tp => sub { 




2503




 





 





 





 





 





 



       my $date = shift; 




2504




 





 





 





 





 





 



       return Time::Piece->strptime($date, '%Y-%m-%d'); 




2505




 





 





 





 





 





 



     } 




2506




 





 





 





 





 





 



   ); 




2507




 





 





 





 





 





 



    




2508




 





 





 





 





 





 



 Register filters, used by C option of many methods. 




2509




 





 





 





 





 





 



   




2510




 





 





 





 





 





 



 =head2 select 




2511




 





 





 





 





 





 



   




2512




 





 





 





 





 





 



   my $result = $dbi->select( 




2513




 





 





 





 





 





 



     column => ['author', 'title'], 




2514




 





 





 





 





 





 



     table  => 'book', 




2515




 





 





 





 





 





 



     where  => {author => 'Ken'}, 




2516




 





 





 





 





 





 



   ); 




2517




 





 





 





 





 





 



    




2518




 





 





 





 





 





 



 Execute select statement. 




2519




 





 





 





 





 





 



   




2520




 





 





 





 





 





 



 You can pass odd number arguments. first argument is C. 




2521




 





 





 





 





 





 



   




2522




 





 





 





 





 





 



   my $result = $dbi->select(['author', 'title'], table => 'book'); 




2523




 





 





 





 





 





 



   




2524




 





 





 





 





 





 



 B 




2525




 





 





 





 





 





 



   




2526




 





 





 





 





 





 



 C method use all of C method's options, 




2527




 





 





 





 





 





 



 and use the following new ones. 




2528




 





 





 





 





 





 



   




2529




 





 





 





 





 





 



 =over 4 




2530




 





 





 





 





 





 



   




2531




 





 





 





 





 





 



 =item column 




2532




 





 





 





 





 





 



    




2533




 





 





 





 





 





 



   column => 'author' 




2534




 





 





 





 





 





 



   column => ['author', 'title'] 




2535




 





 





 





 





 





 



   




2536




 





 





 





 





 





 



 Column clause. 




2537




 





 





 





 





 





 



    




2538




 





 





 





 





 





 



 if C is not specified, '*' is set. 




2539




 





 





 





 





 





 



   




2540




 





 





 





 





 





 



   column => '*' 




2541




 





 





 





 





 





 



   




2542




 





 





 





 





 





 



 You can specify hash of array reference. 




2543




 





 





 





 





 





 



   




2544




 





 





 





 





 





 



   column => [ 




2545




 





 





 





 





 





 



     {book => [qw/author title/]}, 




2546




 





 





 





 





 





 



     {person => [qw/name age/]} 




2547




 





 





 





 





 





 



   ] 




2548




 





 





 





 





 





 



   




2549




 





 





 





 





 





 



 This is expanded to the following one by using C method. 




2550




 





 





 





 





 





 



   




2551




 





 





 





 





 





 



   book.author as "book.author", 




2552




 





 





 





 





 





 



   book.title as "book.title", 




2553




 





 





 





 





 





 



   person.name as "person.name", 




2554




 





 





 





 





 





 



   person.age as "person.age" 




2555




 





 





 





 





 





 



   




2556




 





 





 





 





 





 



 You can specify own column by C<__MY__>. 




2557




 





 





 





 





 





 



   




2558




 





 





 





 





 





 



   column => [ 




2559




 





 





 





 





 





 



     {__MY__ => [qw/author title/]}, 




2560




 





 





 





 





 





 



   ] 




2561




 





 





 





 





 





 



   




2562




 





 





 





 





 





 



 This is expanded to the following one by using C method. 




2563




 





 





 





 





 





 



   




2564




 





 





 





 





 





 



   book.author as "author", 




2565




 





 





 





 





 





 



   book.title as "title", 




2566




 





 





 





 





 





 



   




2567




 





 





 





 





 





 



 C<__MY__> can be changed by C attribute. 




2568




 





 





 





 





 





 



   




2569




 





 





 





 





 





 



 =item param 




2570




 





 





 





 





 





 



   




2571




 





 





 





 





 





 



   param => {'table2.key3' => 5} 




2572




 





 





 





 





 





 



   




2573




 





 





 





 





 





 



 Parameter shown before where clause. 




2574




 





 





 





 





 





 



    




2575




 





 





 





 





 





 



 For example, if you want to contain named placeholder in join clause,  




2576




 





 





 





 





 





 



 you can pass parameter by C option. 




2577




 





 





 





 





 





 



   




2578




 





 





 





 





 





 



   join  => ['inner join (select * from table2 where table2.key3 = :table2.key3)' .  




2579




 





 





 





 





 





 



             ' as table2 on table1.key1 = table2.key1'] 




2580




 





 





 





 





 





 



   




2581




 





 





 





 





 





 



 =item prefix 




2582




 





 





 





 





 





 



   




2583




 





 





 





 





 





 



   prefix => 'SQL_CALC_FOUND_ROWS' 




2584




 





 





 





 





 





 



   




2585




 





 





 





 





 





 



 Prefix of column clause 




2586




 





 





 





 





 





 



   




2587




 





 





 





 





 





 



   select SQL_CALC_FOUND_ROWS title, author from book; 




2588




 





 





 





 





 





 



   




2589




 





 





 





 





 





 



 =item join 




2590




 





 





 





 





 





 



   




2591




 





 





 





 





 





 



   join => [ 




2592




 





 





 





 





 





 



     'left outer join company on book.company_id = company_id', 




2593




 





 





 





 





 





 



     'left outer join location on company.location_id = location.id' 




2594




 





 





 





 





 





 



   ] 




2595




 





 





 





 





 





 



        




2596




 





 





 





 





 





 



 Join clause. If column clause or where clause contain table name like "company.name", 




2597




 





 





 





 





 





 



 join clauses needed when SQL is created is used automatically. 




2598




 





 





 





 





 





 



   




2599




 





 





 





 





 





 



   $dbi->select( 




2600




 





 





 





 





 





 



     table => 'book', 




2601




 





 





 





 





 





 



     column => ['company.location_id as location_id'], 




2602




 





 





 





 





 





 



     where => {'company.name' => 'Orange'}, 




2603




 





 





 





 





 





 



     join => [ 




2604




 





 





 





 





 





 



       'left outer join company on book.company_id = company.id', 




2605




 





 





 





 





 





 



       'left outer join location on company.location_id = location.id' 




2606




 





 





 





 





 





 



     ] 




2607




 





 





 





 





 





 



   ); 




2608




 





 





 





 





 





 



   




2609




 





 





 





 





 





 



 In above select, column and where clause contain "company" table, 




2610




 





 





 





 





 





 



 the following SQL is created 




2611




 





 





 





 





 





 



   




2612




 





 





 





 





 





 



   select company.location_id as location_id 




2613




 





 





 





 





 





 



   from book 




2614




 





 





 





 





 





 



     left outer join company on book.company_id = company.id 




2615




 





 





 





 





 





 



   where company.name = ?; 




2616




 





 





 





 





 





 



   




2617




 





 





 





 





 





 



 You can specify two table by yourself. This is useful when join parser can't parse 




2618




 





 





 





 





 





 



 the join clause correctly. 




2619




 





 





 





 





 





 



   




2620




 





 





 





 





 





 



   $dbi->select( 




2621




 





 





 





 





 





 



     table => 'book', 




2622




 





 





 





 





 





 



     column => ['company.location_id as location_id'], 




2623




 





 





 





 





 





 



     where => {'company.name' => 'Orange'}, 




2624




 





 





 





 





 





 



     join => [ 




2625




 





 





 





 





 





 



       { 




2626




 





 





 





 





 





 



         clause => 'left outer join location on company.location_id = location.id', 




2627




 





 





 





 





 





 



         table => ['company', 'location'] 




2628




 





 





 





 





 





 



       } 




2629




 





 





 





 





 





 



     ] 




2630




 





 





 





 





 





 



   ); 




2631




 





 





 





 





 





 



   




2632




 





 





 





 





 





 



 =item table 




2633




 





 





 





 





 





 



   




2634




 





 





 





 





 





 



   table => 'book' 




2635




 





 





 





 





 





 



   




2636




 





 





 





 





 





 



 Table name. 




2637




 





 





 





 





 





 



   




2638




 





 





 





 





 





 



 =item where 




2639




 





 





 





 





 





 



    




2640




 





 





 





 





 





 



   # (1) Hash reference 




2641




 





 





 





 





 





 



   where => {author => 'Ken', 'title' => ['Perl', 'Ruby']} 




2642




 





 





 





 





 





 



   # -> where author = 'Ken' and title in ('Perl', 'Ruby') 




2643




 





 





 





 





 





 



    




2644




 





 





 





 





 





 



   # (2) DBIx::Custom::Where object 




2645




 





 





 





 





 





 



   where => $dbi->where( 




2646




 





 





 





 





 





 



     clause => ['and', ':author{=}', ':title{like}'], 




2647




 





 





 





 





 





 



     param  => {author => 'Ken', title => '%Perl%'} 




2648




 





 





 





 





 





 



   ) 




2649




 





 





 





 





 





 



   # -> where author = 'Ken' and title like '%Perl%' 




2650




 





 





 





 





 





 



    




2651




 





 





 





 





 





 



   # (3) Array reference[where clause, parameters, join(optional)] 




2652




 





 





 





 





 





 



   where => [ 




2653




 





 





 





 





 





 



     ['and', ':author{=}', ':title{like}'], 




2654




 





 





 





 





 





 



     {author => 'Ken', title => '%Perl%'}, 




2655




 





 





 





 





 





 



     ["left outer join table2 on table1.key1 = table2.key1"] 




2656




 





 





 





 





 





 



   ] 




2657




 





 





 





 





 





 



   # -> where author = 'Ken' and title like '%Perl%' 




2658




 





 





 





 





 





 



    




2659




 





 





 





 





 





 



   # (4) Array reference[String, Hash reference] 




2660




 





 





 





 





 





 



   where => [ 




2661




 





 





 





 





 





 



     ':author{=} and :title{like}', 




2662




 





 





 





 





 





 



     {author => 'Ken', title => '%Perl%'} 




2663




 





 





 





 





 





 



   ] 




2664




 





 





 





 





 





 



   #  -> where author = 'Ken' and title like '%Perl%' 




2665




 





 





 





 





 





 



    




2666




 





 





 





 





 





 



   # (5) String 




2667




 





 





 





 





 





 



   where => 'title is null' 




2668




 





 





 





 





 





 



   #  -> where title is null 




2669




 





 





 





 





 





 



   




2670




 





 





 





 





 





 



 Where clause. 




2671




 





 





 





 





 





 



 See also L to know how to create where clause. 




2672




 





 





 





 





 





 



    




2673




 





 





 





 





 





 



 =back 




2674




 





 





 





 





 





 



   




2675




 





 





 





 





 





 



 =head2 type_rule 




2676




 





 





 





 





 





 



   




2677




 





 





 





 





 





 



   $dbi->type_rule( 




2678




 





 





 





 





 





 



     into1 => { 




2679




 





 





 





 





 





 



       date => sub { ... }, 




2680




 





 





 





 





 





 



       datetime => sub { ... } 




2681




 





 





 





 





 





 



     }, 




2682




 





 





 





 





 





 



     into2 => { 




2683




 





 





 





 





 





 



       date => sub { ... }, 




2684




 





 





 





 





 





 



       datetime => sub { ... } 




2685




 





 





 





 





 





 



     }, 




2686




 





 





 





 





 





 



     from1 => { 




2687




 





 





 





 





 





 



       # DATE 




2688




 





 





 





 





 





 



       9 => sub { ... }, 




2689




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2690




 





 





 





 





 





 



       11 => sub { ... }, 




2691




 





 





 





 





 





 



     } 




2692




 





 





 





 





 





 



     from2 => { 




2693




 





 





 





 





 





 



       # DATE 




2694




 





 





 





 





 





 



       9 => sub { ... }, 




2695




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2696




 





 





 





 





 





 



       11 => sub { ... }, 




2697




 





 





 





 





 





 



     } 




2698




 





 





 





 





 





 



   ); 




2699




 





 





 





 





 





 



   




2700




 





 





 





 





 





 



 Filtering rule when data is send into and get from database. 




2701




 





 





 





 





 





 



 This has a little complex problem. 




2702




 





 





 





 





 





 



   




2703




 





 





 





 





 





 



 In C and C you can specify 




2704




 





 





 





 





 





 



 type name as same as type name defined 




2705




 





 





 





 





 





 



 by create table, such as C or C. 




2706




 





 





 





 





 





 



   




2707




 





 





 





 





 





 



 Note that type name and data type don't contain upper case. 




2708




 





 





 





 





 





 



 If these contain upper case character, you convert it to lower case. 




2709




 





 





 





 





 





 



   




2710




 





 





 





 





 





 



 C is executed after C. 




2711




 





 





 





 





 





 



   




2712




 





 





 





 





 





 



 Type rule of C and C is enabled on the following 




2713




 





 





 





 





 





 



 column name. 




2714




 





 





 





 





 





 



   




2715




 





 





 





 





 





 



 =over 4 




2716




 





 





 





 





 





 



   




2717




 





 





 





 





 





 



 =item 1. column name 




2718




 





 





 





 





 





 



   




2719




 





 





 





 





 





 



   issue_date 




2720




 





 





 





 





 





 



   issue_datetime 




2721




 





 





 





 





 





 



   




2722




 





 





 





 





 





 



 This need C option in each method. 




2723




 





 





 





 





 





 



   




2724




 





 





 





 





 





 



 =item 2. table name and column name, separator is dot 




2725




 





 





 





 





 





 



   




2726




 





 





 





 





 





 



   book.issue_date 




2727




 





 





 





 





 





 



   book.issue_datetime 




2728




 





 





 





 





 





 



   




2729




 





 





 





 





 





 



 =back 




2730




 





 





 





 





 





 



   




2731




 





 





 





 





 





 



 You get all type name used in database by C. 




2732




 





 





 





 





 





 



   




2733




 





 





 





 





 





 



   print $dbi->available_typename; 




2734




 





 





 





 





 





 



   




2735




 





 





 





 





 





 



 In C and C you specify data type, not type name. 




2736




 





 





 





 





 





 



 C is executed after C. 




2737




 





 





 





 





 





 



 You get all data type by C. 




2738




 





 





 





 





 





 



   




2739




 





 





 





 





 





 



   print $dbi->available_datatype; 




2740




 





 





 





 





 





 



   




2741




 





 





 





 





 





 



 You can also specify multiple types at once. 




2742




 





 





 





 





 





 



   




2743




 





 





 





 





 





 



   $dbi->type_rule( 




2744




 





 





 





 





 





 



     into1 => [ 




2745




 





 





 





 





 





 



       [qw/DATE DATETIME/] => sub { ... }, 




2746




 





 





 





 





 





 



     ], 




2747




 





 





 





 





 





 



   ); 




2748




 





 





 





 





 





 



   




2749




 





 





 





 





 





 



 =head2 update 




2750




 





 





 





 





 





 



   




2751




 





 





 





 





 





 



   $dbi->update({title => 'Perl'}, table  => 'book', where  => {id => 4}); 




2752




 





 





 





 





 





 



   




2753




 





 





 





 





 





 



 Execute update statement. First argument is update row data. 




2754




 





 





 





 





 





 



   




2755




 





 





 





 





 





 



 If you want to set constant value to row data, use scalar reference 




2756




 





 





 





 





 





 



 as parameter value. 




2757




 





 





 





 





 





 



   




2758




 





 





 





 





 





 



   {date => \"NOW()"} 




2759




 





 





 





 





 





 



   




2760




 





 





 





 





 





 



 B 




2761




 





 





 





 





 





 



   




2762




 





 





 





 





 





 



 C method use all of C method's options, 




2763




 





 





 





 





 





 



 and use the following new ones. 




2764




 





 





 





 





 





 



   




2765




 





 





 





 





 





 



 =over 4 




2766




 





 





 





 





 





 



   




2767




 





 





 





 





 





 



 =item prefix 




2768




 





 





 





 





 





 



   




2769




 





 





 





 





 





 



   prefix => 'or replace' 




2770




 





 





 





 





 





 



   




2771




 





 





 





 





 





 



 prefix before table name section 




2772




 





 





 





 





 





 



   




2773




 





 





 





 





 





 



   update or replace book 




2774




 





 





 





 





 





 



   




2775




 





 





 





 





 





 



 =item table 




2776




 





 





 





 





 





 



   




2777




 





 





 





 





 





 



   table => 'book' 




2778




 





 





 





 





 





 



   




2779




 





 





 





 





 





 



 Table name. 




2780




 





 





 





 





 





 



   




2781




 





 





 





 





 





 



 =item where 




2782




 





 





 





 





 





 



   




2783




 





 





 





 





 





 



 Same as C method's C option. 




2784




 





 





 





 





 





 



   




2785




 





 





 





 





 





 



 =item wrap 




2786




 





 





 





 





 





 



   




2787




 





 





 





 





 





 



   wrap => {price => sub { "max($_[0])" }} 




2788




 





 





 





 





 





 



   




2789




 





 





 





 





 





 



 placeholder wrapped string. 




2790




 





 





 





 





 





 



   




2791




 





 





 





 





 





 



 If the following statement 




2792




 





 





 





 





 





 



   




2793




 





 





 





 





 





 



   $dbi->update({price => 100}, table => 'book', 




2794




 





 





 





 





 





 



     {price => sub { "$_[0] + 5" }}); 




2795




 





 





 





 





 





 



   




2796




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2797




 





 





 





 





 





 



   




2798




 





 





 





 





 





 



   update book set price =  ? + 5; 




2799




 





 





 





 





 





 



   




2800




 





 





 





 





 





 



 =item mtime 




2801




 





 





 





 





 





 



   




2802




 





 





 





 





 





 



   mtime => 'modified_time' 




2803




 





 





 





 





 





 



   




2804




 





 





 





 





 





 



 Modified time column name. time row is updated is set to the column. 




2805




 





 





 





 





 





 



 default time format is C, which can be changed by 




2806




 





 





 





 





 





 



 C attribute. 




2807




 





 





 





 





 





 



   




2808




 





 





 





 





 





 



 =back 




2809




 





 





 





 





 





 



   




2810




 





 





 





 





 





 



 =head2 update_all 




2811




 





 





 





 





 





 



   




2812




 





 





 





 





 





 



   $dbi->update_all({title => 'Perl'}, table => 'book', ); 




2813




 





 





 





 





 





 



   




2814




 





 





 





 





 





 



 Execute update statement for all rows. 




2815




 





 





 





 





 





 



 Options is same as C method. 




2816




 





 





 





 





 





 



   




2817




 





 





 





 





 





 



 =over 4 




2818




 





 





 





 





 





 



   




2819




 





 





 





 





 





 



 =item option 




2820




 





 





 





 





 





 



   




2821




 





 





 





 





 





 



   option => { 




2822




 





 





 





 





 





 



     select => { 




2823




 





 





 





 





 





 



       append => '...' 




2824




 





 





 





 





 





 



     }, 




2825




 





 





 





 





 





 



     insert => { 




2826




 





 





 





 





 





 



       prefix => '...' 




2827




 





 





 





 





 





 



     }, 




2828




 





 





 





 





 





 



     update => { 




2829




 





 





 





 





 





 



       filter => {} 




2830




 





 





 





 





 





 



     } 




2831




 





 





 





 





 





 



   } 




2832




 





 





 





 





 





 



   




2833




 





 





 





 





 





 



 If you want to pass option to each method, 




2834




 





 





 





 





 





 



 you can use C option. 




2835




 





 





 





 





 





 



   




2836




 





 





 





 





 





 



 =over 4 




2837




 





 





 





 





 





 



   




2838




 





 





 





 





 





 



 =item select_option 




2839




 





 





 





 





 





 



   




2840




 





 





 





 





 





 



   select_option => {append => 'for update'} 




2841




 





 





 





 





 





 



   




2842




 





 





 





 





 





 



 select method option, 




2843




 





 





 





 





 





 



 select method is used to check the row is already exists. 




2844




 





 





 





 





 





 



   




2845




 





 





 





 





 





 



 =head2 show_datatype 




2846




 





 





 





 





 





 



   




2847




 





 





 





 





 





 



   $dbi->show_datatype($table); 




2848




 





 





 





 





 





 



   




2849




 





 





 





 





 





 



 Show data type of the columns of specified table. 




2850




 





 





 





 





 





 



   




2851




 





 





 





 





 





 



   book 




2852




 





 





 





 





 





 



   title: 5 




2853




 





 





 





 





 





 



   issue_date: 91 




2854




 





 





 





 





 





 



   




2855




 





 





 





 





 





 



 This data type is used in C's C and C. 




2856




 





 





 





 





 





 



   




2857




 





 





 





 





 





 



 =head2 show_tables 




2858




 





 





 





 





 





 



   




2859




 





 





 





 





 





 



   $dbi->show_tables; 




2860




 





 





 





 





 





 



   




2861




 





 





 





 





 





 



 Show tables. 




2862




 





 





 





 





 





 



   




2863




 





 





 





 





 





 



 =head2 show_typename 




2864




 





 





 





 





 





 



   




2865




 





 





 





 





 





 



   $dbi->show_typename($table); 




2866




 





 





 





 





 





 



   




2867




 





 





 





 





 





 



 Show type name of the columns of specified table. 




2868




 





 





 





 





 





 



   




2869




 





 





 





 





 





 



   book 




2870




 





 





 





 





 





 



   title: varchar 




2871




 





 





 





 





 





 



   issue_date: date 




2872




 





 





 





 





 





 



   




2873




 





 





 





 





 





 



 This type name is used in C's C and C. 




2874




 





 





 





 





 





 



   




2875




 





 





 





 





 





 



 =head2 values_clause 




2876




 





 





 





 





 





 



   




2877




 





 





 





 





 





 



   my $values_clause = $dbi->values_clause({title => 'a', age => 2}); 




2878




 





 





 





 





 





 



   




2879




 





 





 





 





 





 



 Create values clause. 




2880




 





 





 





 





 





 



   




2881




 





 





 





 





 





 



   (title, author) values (title = :title, age = :age); 




2882




 





 





 





 





 





 



   




2883




 





 





 





 





 





 



 You can use this in insert statement. 




2884




 





 





 





 





 





 



   




2885




 





 





 





 





 





 



   my $insert_sql = "insert into book $values_clause"; 




2886




 





 





 





 





 





 



   




2887




 





 





 





 





 





 



 =head2 where 




2888




 





 





 





 





 





 



   




2889




 





 





 





 





 





 



   my $where = $dbi->where; 




2890




 





 





 





 





 





 



   $where->clause(['and', 'title = :title', 'author = :author']); 




2891




 





 





 





 





 





 



   $where->param({title => 'Perl', author => 'Ken'}); 




2892




 





 





 





 





 





 



   $where->join(['left join author on book.author = author.id]); 




2893




 





 





 





 





 





 



   




2894




 





 





 





 





 





 



 Create a new L object. 




2895




 





 





 





 





 





 



 See L to know how to create where clause. 




2896




 





 





 





 





 





 



   




2897




 





 





 





 





 





 



 =head1 ENVIRONMENTAL VARIABLES 




2898




 





 





 





 





 





 



   




2899




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG 




2900




 





 





 





 





 





 



   




2901




 





 





 





 





 





 



 If environment variable C is set to true, 




2902




 





 





 





 





 





 



 executed SQL and bind values are printed to STDERR. 




2903




 





 





 





 





 





 



   




2904




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG_ENCODING 




2905




 





 





 





 





 





 



   




2906




 





 





 





 





 





 



 DEBUG output encoding. Default to UTF-8. 




2907




 





 





 





 





 





 



   




2908




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION 




2909




 





 





 





 





 





 



   




2910




 





 





 





 





 





 



   $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25'; 




2911




 





 





 





 





 





 



   




2912




 





 





 





 





 





 



 Suppress deprecation warnings before specified version. 




2913




 





 





 





 





 





 



   




2914




 





 





 





 





 





 



 =head1 DEPRECATED FUNCTIONALITY 




2915




 





 





 





 





 





 



   




2916




 





 





 





 





 





 



 L 




2917




 





 





 





 





 





 



   




2918




 





 





 





 





 





 



   # Methods 




2919




 





 





 





 





 





 



   DBIx::Custom AUTOLOAD feature # will be removed at 2022/5/1 




2920




 





 





 





 





 





 



   DBIx::Custom::helper method # will be removed at 2022/5/1 




2921




 





 





 





 





 





 



   DBIx::Custom::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1 




2922




 





 





 





 





 





 



   DBIx::Custom::count method # will be removed at 2022/5/1 




2923




 





 





 





 





 





 



   DBIx::Custom::select,update,delete method's primary_key option is DEPRECATED! # will be removed at 2022/5/1 




2924




 





 





 





 





 





 



   DBIx::Custom::select,update,delete method's id option is DEPRECATED! # will be removed at 2022/5/1 




2925




 





 





 





 





 





 



   DBIx::Custom::setup method is DEPRECATED! # will be removed at 2022/5/1 




2926




 





 





 





 





 





 



   




2927




 





 





 





 





 





 



 L 




2928




 





 





 





 





 





 



    




2929




 





 





 





 





 





 



   # Options 




2930




 





 





 





 





 





 



   kv method's multi option (from 0.28) # will be removed at 2018/3/1 




2931




 





 





 





 





 





 



   




2932




 





 





 





 





 





 



 L 




2933




 





 





 





 





 





 



   




2934




 





 





 





 





 





 



   DBIx::Custom::Model AUTOLOAD feature # will be removed at 2022/5/1 




2935




 





 





 





 





 





 



   DBIx::Custom::Model::helper method is DEPRECATED! # will be removed at 2022/5/1 




2936




 





 





 





 





 





 



   DBIx::Custom::Model::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1 




2937




 





 





 





 





 





 



   DBIx::Custom::Model::count method # will be removed at 2022/5/1 




2938




 





 





 





 





 





 



   DBIx::Custom::Model::primary_key attribute is DEPRECATED! # will be removed at 2022/5/1 




2939




 





 





 





 





 





 



   




2940




 





 





 





 





 





 



 =head1 BACKWARDS COMPATIBILITY POLICY 




2941




 





 





 





 





 





 



   




2942




 





 





 





 





 





 



 If a feature is DEPRECATED, you can know it by DEPRECATED warnings. 




2943




 





 





 





 





 





 



 DEPRECATED feature is removed after C, 




2944




 





 





 





 





 





 



 but if at least one person use the feature and tell me that thing 




2945




 





 





 





 





 





 



 I extend one year each time he tell me it. 




2946




 





 





 





 





 





 



   




2947




 





 





 





 





 





 



 DEPRECATION warnings can be suppressed by C 




2948




 





 





 





 





 





 



 environment variable. 




2949




 





 





 





 





 





 



   




2950




 





 





 





 





 





 



 EXPERIMENTAL features will be changed or deleted without warnings. 




2951




 





 





 





 





 





 



   




2952




 





 





 





 





 





 



 =head1 BUGS 




2953




 





 





 





 





 





 



   




2954




 





 





 





 





 





 



 Please tell me bugs if you find bug. 




2955




 





 





 





 





 





 



   




2956




 





 





 





 





 





 



 C<<  >> 




2957




 





 





 





 





 





 



   




2958




 





 





 





 





 





 



 L 




2959




 





 





 





 





 





 



   




2960




 





 





 





 





 





 



 =head1 AUTHOR 




2961




 





 





 





 





 





 



   




2962




 





 





 





 





 





 



 Yuki Kimoto, C<<  >> 




2963




 





 





 





 





 





 



   




2964




 





 





 





 





 





 



 =head1 COPYRIGHT & LICENSE 




2965




 





 





 





 





 





 



   




2966




 





 





 





 





 





 



 Copyright 2009-2019 Yuki Kimoto, all rights reserved. 




2967




 





 





 





 





 





 



   




2968




 





 





 





 





 





 



 This program is free software; you can redistribute it and/or modify it 




2969




 





 





 





 





 





 



 under the same terms as Perl itself. 




2970




 





 





 





 





 





 



   




2971




 





 





 





 





 





 



 =cut
C, and C.

If C is set, C method use C
information, you can improve the performance of C in
the following way.

  my $column_infos = $dbi->get_column_info(exclude_table => qr/^system_/);
  $dbi->user_column_info($column_info);
  $dbi->each_column(sub { ... });

=head2 each_table

  $dbi->each_table(
    sub {
      my ($dbi, $table, $table_info) = @_;

      my $table_name = $table_info->{TABLE_NAME};
    }
  );

Iterate all table information from in database.
Argument is callback which is executed when one table is found.
Callback receive three arguments, C, C, 




2081




 





 





 





 





 





 



 C. 




2082




 





 





 





 





 





 



   




2083




 





 





 





 





 





 



 If C is set, C method use C 




2084




 





 





 





 





 





 



 information, you can improve the performance of C in 




2085




 





 





 





 





 





 



 the following way. 




2086




 





 





 





 





 





 



   




2087




 





 





 





 





 





 



   my $table_infos = $dbi->get_table_info(exclude => qr/^system_/); 




2088




 





 





 





 





 





 



   $dbi->user_table_info($table_info); 




2089




 





 





 





 





 





 



   $dbi->each_table(sub { ... }); 




2090




 





 





 





 





 





 



   




2091




 





 





 





 





 





 



 =head2 execute 




2092




 





 





 





 





 





 



   




2093




 





 





 





 





 





 



   my $result = $dbi->execute( 




2094




 





 





 





 





 





 



     "select * from book where title = :title and author like :author", 




2095




 





 





 





 





 





 



     {title => 'Perl', author => '%Ken%'} 




2096




 





 





 





 





 





 



   ); 




2097




 





 





 





 





 





 



   




2098




 





 





 





 





 





 



   my $result = $dbi->execute( 




2099




 





 





 





 





 





 



     "select * from book where title = :book.title and author like :book.author", 




2100




 





 





 





 





 





 



     {'book.title' => 'Perl', 'book.author' => '%Ken%'} 




2101




 





 





 





 





 





 



   ); 




2102




 





 





 





 





 





 



   




2103




 





 





 





 





 





 



 Execute SQL. SQL can contain column parameter such as :author and :title. 




2104




 





 





 





 





 





 



 You can append table name to column name such as :book.title and :book.author. 




2105




 





 





 





 





 





 



 Second argument is data, embedded into column parameter. 




2106




 





 





 





 





 





 



 Return value is L object when select statement is executed, 




2107




 





 





 





 





 





 



 or the count of affected rows when insert, update, delete statement is executed. 




2108




 





 





 





 





 





 



   




2109




 





 





 





 





 





 



 Named placeholder such as C<:title> is replaced by placeholder C. 




2110




 





 





 





 





 





 



    




2111




 





 





 





 





 





 



   # Original 




2112




 





 





 





 





 





 



   select * from book where title = :title and author like :author 




2113




 





 





 





 





 





 



    




2114




 





 





 





 





 





 



   # Replaced 




2115




 





 





 





 





 





 



   select * from where title = ? and author like ?; 




2116




 





 





 





 





 





 



   




2117




 





 





 





 





 





 



 You can specify operator with named placeholder 




2118




 





 





 





 





 





 



 by C syntax. 




2119




 





 





 





 





 





 



   




2120




 





 





 





 





 





 



   # Original 




2121




 





 





 





 





 





 



   select * from book where :title{=} and :author{like} 




2122




 





 





 





 





 





 



    




2123




 





 





 





 





 





 



   # Replaced 




2124




 





 





 





 





 





 



   select * from where title = ? and author like ?; 




2125




 





 





 





 





 





 



   




2126




 





 





 





 





 





 



 Note that colons in time format such as 12:13:15 is an exception, 




2127




 





 





 





 





 





 



 it is not parsed as named placeholder. 




2128




 





 





 





 





 





 



 If you want to use colon generally, you must escape it by C<\\> 




2129




 





 





 





 





 





 



   




2130




 





 





 





 





 





 



   select * from where title = "aa\\:bb"; 




2131




 





 





 





 





 





 



   




2132




 





 





 





 





 





 



 B 




2133




 





 





 





 





 





 



   




2134




 





 





 





 





 





 



 The following options are available. 




2135




 





 





 





 





 





 



   




2136




 





 





 





 





 





 



 =over 4 




2137




 





 





 





 





 





 



   




2138




 





 





 





 





 





 



 =item after_build_sql  




2139




 





 





 





 





 





 



   




2140




 





 





 





 





 





 



 You can filter sql after the sql is build. 




2141




 





 





 





 





 





 



   




2142




 





 





 





 





 





 



   after_build_sql => $code_ref 




2143




 





 





 





 





 





 



   




2144




 





 





 





 





 





 



 The following one is one example. 




2145




 





 





 





 





 





 



   




2146




 





 





 





 





 





 



   $dbi->select( 




2147




 





 





 





 





 





 



     table => 'book', 




2148




 





 





 





 





 





 



     column => 'distinct(name)', 




2149




 





 





 





 





 





 



     after_build_sql => sub { 




2150




 





 





 





 





 





 



       "select count(*) from ($_[0]) as t1" 




2151




 





 





 





 





 





 



     } 




2152




 





 





 





 





 





 



   ); 




2153




 





 





 





 





 





 



   




2154




 





 





 





 





 





 



 The following SQL is executed. 




2155




 





 





 





 





 





 



   




2156




 





 





 





 





 





 



   select count(*) from (select distinct(name) from book) as t1; 




2157




 





 





 





 





 





 



   




2158




 





 





 





 





 





 



 =item append 




2159




 





 





 





 





 





 



   




2160




 





 





 





 





 





 



   append => 'order by name' 




2161




 





 





 





 





 





 



   




2162




 





 





 





 





 





 



 Append some statement after SQL. 




2163




 





 





 





 





 





 



   




2164




 





 





 





 





 





 



 =item bind_type 




2165




 





 





 





 





 





 



   




2166




 





 





 





 





 





 



 Specify database bind data type. 




2167




 





 





 





 





 





 



    




2168




 





 





 





 





 





 



   bind_type => {image => DBI::SQL_BLOB} 




2169




 





 





 





 





 





 



   bind_type => [image => DBI::SQL_BLOB] 




2170




 





 





 





 





 





 



   bind_type => [[qw/image audio/] => DBI::SQL_BLOB] 




2171




 





 





 





 





 





 



   




2172




 





 





 





 





 





 



 This is used to bind parameter by C of statement handle. 




2173




 





 





 





 





 





 



   




2174




 





 





 





 





 





 



   $sth->bind_param($pos, $value, DBI::SQL_BLOB); 




2175




 





 





 





 





 





 



   




2176




 





 





 





 





 





 



 =item filter 




2177




 





 





 





 





 





 



    




2178




 





 





 





 





 





 



   filter => { 




2179




 





 





 





 





 





 



     title  => sub { uc $_[0] } 




2180




 





 





 





 





 





 



     author => sub { uc $_[0] } 




2181




 





 





 





 





 





 



   } 




2182




 





 





 





 





 





 



   




2183




 





 





 





 





 





 



   # Filter name 




2184




 





 





 





 





 





 



   filter => { 




2185




 





 





 





 





 





 



     title  => 'upper_case', 




2186




 





 





 





 





 





 



     author => 'upper_case' 




2187




 





 





 





 





 





 



   } 




2188




 





 





 





 





 





 



        




2189




 





 





 





 





 





 



   # At once 




2190




 





 





 





 





 





 



   filter => [ 




2191




 





 





 





 





 





 



     [qw/title author/]  => sub { uc $_[0] } 




2192




 





 





 





 





 





 



   ] 




2193




 





 





 





 





 





 



   




2194




 





 





 





 





 





 



 Filter. You can set subroutine or filter name 




2195




 





 





 





 





 





 



 registered by C. 




2196




 





 





 





 





 





 



 This filter is executed before data is saved into database. 




2197




 





 





 





 





 





 



 and before type rule filter is executed. 




2198




 





 





 





 





 





 



   




2199




 





 





 





 





 





 



 =item reuse 




2200




 





 





 





 





 





 



    




2201




 





 





 





 





 





 



   reuse => $hash_ref 




2202




 





 





 





 





 





 



   




2203




 





 





 





 





 





 



 Reuse statement handle in same SQL. 




2204




 





 





 





 





 





 



    




2205




 





 





 





 





 





 



   my $reuse = {}; 




2206




 





 





 





 





 





 



   $dbi->execute($sql, $param, reuse => $reuse); 




2207




 





 





 





 





 





 



   




2208




 





 





 





 





 





 



 This will improved performance when you want to execute same sql repeatedly. 




2209




 





 





 





 





 





 



   




2210




 





 





 





 





 





 



 =item table 




2211




 





 





 





 





 





 



    




2212




 





 





 





 





 





 



   table => 'author' 




2213




 





 





 





 





 





 



   




2214




 





 





 





 





 





 



 If you want to omit table name in column name 




2215




 





 





 





 





 





 



 and enable C and C type filter, 




2216




 





 





 





 





 





 



 You must set C option. 




2217




 





 





 





 





 





 



   




2218




 





 





 





 





 





 



   $dbi->execute("select * from book where title = :title and author = :author", 




2219




 





 





 





 





 





 



     {title => 'Perl', author => 'Ken', table => 'book'); 




2220




 





 





 





 





 





 



   




2221




 





 





 





 





 





 



   # Same 




2222




 





 





 





 





 





 



   $dbi->execute( 




2223




 





 





 





 





 





 



     "select * from book where title = :book.title and author = :book.author", 




2224




 





 





 





 





 





 



     {title => 'Perl', author => 'Ken'); 




2225




 





 





 





 





 





 



   




2226




 





 





 





 





 





 



 =item table_alias 




2227




 





 





 





 





 





 



   




2228




 





 





 





 





 





 



   table_alias => {worker => 'user'} # {ALIAS => TABLE} 




2229




 





 





 





 





 





 



   




2230




 





 





 





 





 





 



 Table alias. Key is alias table name, value is real table name, . 




2231




 





 





 





 





 





 



 If you set C, you can enable C and C type rule 




2232




 





 





 





 





 





 



 on alias table name. 




2233




 





 





 





 





 





 



   




2234




 





 





 





 





 





 



 =item type_rule_off 




2235




 





 





 





 





 





 



   




2236




 





 





 





 





 





 



   type_rule_off => 1 




2237




 





 





 





 





 





 



   




2238




 





 





 





 





 





 



 Turn C and C type rule off. 




2239




 





 





 





 





 





 



   




2240




 





 





 





 





 





 



 =item type_rule1_off 




2241




 





 





 





 





 





 



   




2242




 





 





 





 





 





 



   type_rule1_off => 1 




2243




 





 





 





 





 





 



   




2244




 





 





 





 





 





 



 Turn C type rule off. 




2245




 





 





 





 





 





 



   




2246




 





 





 





 





 





 



 =item type_rule2_off 




2247




 





 





 





 





 





 



   




2248




 





 





 





 





 





 



   type_rule2_off => 1 




2249




 





 





 





 





 





 



   




2250




 





 





 





 





 





 



 Turn C type rule off. 




2251




 





 





 





 





 





 



   




2252




 





 





 





 





 





 



 =item prepare_attr 




2253




 





 





 





 





 





 



   




2254




 





 





 





 





 





 



   prepare_attr => {mysql_use_result => 1} 




2255




 





 





 





 





 





 



   




2256




 





 





 





 





 





 



 Statemend handle attributes, 




2257




 





 





 





 





 





 



 this is L's C method second argument. 




2258




 





 





 





 





 





 



   




2259




 





 





 





 





 





 



 =head2 get_column_info 




2260




 





 





 





 





 





 



   




2261




 





 





 





 





 





 



   my $column_infos = $dbi->get_column_info(exclude_table => qr/^system_/); 




2262




 





 





 





 





 





 



   




2263




 





 





 





 





 





 



 get column information except for one which match C pattern. 




2264




 





 





 





 





 





 



   




2265




 





 





 





 





 





 



   [ 




2266




 





 





 





 





 





 



     {table => 'book', column => 'title', info => {...}}, 




2267




 





 





 





 





 





 



     {table => 'author', column => 'name' info => {...}} 




2268




 





 





 





 





 





 



   ] 




2269




 





 





 





 





 





 



   




2270




 





 





 





 





 





 



 =head2 get_table_info 




2271




 





 





 





 





 





 



   




2272




 





 





 





 





 





 



   my $table_infos = $dbi->get_table_info(exclude => qr/^system_/); 




2273




 





 





 





 





 





 



   




2274




 





 





 





 





 





 



 get table information except for one which match C pattern. 




2275




 





 





 





 





 





 



   




2276




 





 





 





 





 





 



   [ 




2277




 





 





 





 





 





 



     {table => 'book', info => {...}}, 




2278




 





 





 





 





 





 



     {table => 'author', info => {...}} 




2279




 





 





 





 





 





 



   ] 




2280




 





 





 





 





 





 



   




2281




 





 





 





 





 





 



 You can set this value to C. 




2282




 





 





 





 





 





 



   




2283




 





 





 





 





 





 



 =head2 insert 




2284




 





 





 





 





 





 



   




2285




 





 





 





 





 





 



   $dbi->insert({title => 'Perl', author => 'Ken'}, table  => 'book'); 




2286




 





 





 





 





 





 



   




2287




 





 





 





 





 





 



 Execute insert statement. First argument is row data. Return value is 




2288




 





 





 





 





 





 



 affected row count. 




2289




 





 





 





 





 





 



   




2290




 





 





 





 





 





 



 If you want to set constant value to row data, use scalar reference 




2291




 





 





 





 





 





 



 as parameter value. 




2292




 





 





 





 





 





 



   




2293




 





 





 





 





 





 



   {date => \"NOW()"} 




2294




 





 





 





 





 





 



   




2295




 





 





 





 





 





 



 You can pass multiple parameters, this is very fast. 




2296




 





 





 





 





 





 



   




2297




 





 





 





 





 





 



   $dbi->insert( 




2298




 





 





 





 





 





 



     [ 




2299




 





 





 





 





 





 



       {title => 'Perl', author => 'Ken'}, 




2300




 





 





 





 





 





 



       {title => 'Ruby', author => 'Tom'} 




2301




 





 





 





 





 





 



     ], 




2302




 





 





 





 





 





 



     table  => 'book' 




2303




 





 





 





 





 





 



   ); 




2304




 





 





 





 





 





 



   




2305




 





 





 





 





 





 



 In multiple insert, you can't use C option. 




2306




 





 





 





 





 





 



 and only first parameter is used to create sql. 




2307




 





 





 





 





 





 



   




2308




 





 





 





 





 





 



 B 




2309




 





 





 





 





 





 



   




2310




 





 





 





 





 





 



 C method use all of C method's options, 




2311




 





 





 





 





 





 



 and use the following new ones. 




2312




 





 





 





 





 





 



   




2313




 





 





 





 





 





 



 =over 4 




2314




 





 





 





 





 





 



   




2315




 





 





 





 





 





 



 =item bulk_insert 




2316




 





 





 





 





 





 



   




2317




 





 





 





 





 





 



   bulk_insert => 1 




2318




 





 





 





 





 





 



   




2319




 





 





 





 





 





 



 bulk insert is executed if database support bulk insert and  




2320




 





 





 





 





 





 



 multiple parameters is passed to C. 




2321




 





 





 





 





 





 



 The SQL like the following one is executed. 




2322




 





 





 





 





 





 



   




2323




 





 





 





 





 





 



   insert into book (id, title) values (?, ?), (?, ?); 




2324




 





 





 





 





 





 



   




2325




 





 





 





 





 





 



 =item ctime 




2326




 





 





 





 





 





 



   




2327




 





 





 





 





 





 



   ctime => 'created_time' 




2328




 





 





 





 





 





 



   




2329




 





 





 





 





 





 



 Created time column name. time when row is created is set to the column. 




2330




 





 





 





 





 





 



 default time format is "YYYY-mm-dd HH:MM:SS", which can be changed by 




2331




 





 





 





 





 





 



 C attribute. 




2332




 





 





 





 





 





 



   




2333




 





 





 





 





 





 



 =item prefix 




2334




 





 





 





 





 





 



   




2335




 





 





 





 





 





 



   prefix => 'or replace' 




2336




 





 





 





 





 





 



   




2337




 





 





 





 





 





 



 prefix before table name section 




2338




 





 





 





 





 





 



   




2339




 





 





 





 





 





 



   insert or replace into book 




2340




 





 





 





 





 





 



   




2341




 





 





 





 





 





 



 =item table 




2342




 





 





 





 





 





 



   




2343




 





 





 





 





 





 



   table => 'book' 




2344




 





 





 





 





 





 



   




2345




 





 





 





 





 





 



 Table name. 




2346




 





 





 





 





 





 



   




2347




 





 





 





 





 





 



 =item mtime 




2348




 





 





 





 





 





 



   




2349




 





 





 





 





 





 



 This option is same as C method C option. 




2350




 





 





 





 





 





 



   




2351




 





 





 





 





 





 



 =item wrap 




2352




 





 





 





 





 





 



   




2353




 





 





 





 





 





 



   wrap => {price => sub { "max($_[0])" }} 




2354




 





 





 





 





 





 



   




2355




 





 





 





 





 





 



 placeholder wrapped string. 




2356




 





 





 





 





 





 



   




2357




 





 





 





 





 





 



 If the following statement 




2358




 





 





 





 





 





 



   




2359




 





 





 





 





 





 



   $dbi->insert({price => 100}, table => 'book', 




2360




 





 





 





 





 





 



     {price => sub { "$_[0] + 5" }}); 




2361




 





 





 





 





 





 



   




2362




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2363




 





 





 





 





 





 



   




2364




 





 





 





 





 





 



   insert into book price values ( ? + 5 ); 




2365




 





 





 





 





 





 



   




2366




 





 





 





 





 





 



 =back 




2367




 





 





 





 





 





 



   




2368




 





 





 





 





 





 



 =over 4 




2369




 





 





 





 





 





 



   




2370




 





 





 





 





 





 



 =head2 include_model 




2371




 





 





 





 





 





 



   




2372




 





 





 





 





 





 



   $dbi->include_model('MyModel'); 




2373




 





 





 





 





 





 



   




2374




 





 





 





 





 





 



 Include models from specified namespace, 




2375




 





 





 





 





 





 



 the following layout is needed to include models. 




2376




 





 





 





 





 





 



   




2377




 





 





 





 





 





 



   lib / MyModel.pm 




2378




 





 





 





 





 





 



       / MyModel / book.pm 




2379




 





 





 





 





 





 



                 / company.pm 




2380




 





 





 





 





 





 



   




2381




 





 





 





 





 





 



 Name space module, extending L. 




2382




 





 





 





 





 





 



   




2383




 





 





 





 





 





 



 B 




2384




 





 





 





 





 





 



   




2385




 





 





 





 





 





 



   package MyModel; 




2386




 





 





 





 





 





 



   use DBIx::Custom::Model -base; 




2387




 





 





 





 





 





 



    




2388




 





 





 





 





 





 



   1; 




2389




 





 





 





 





 





 



   




2390




 





 





 





 





 





 



 Model modules, extending name space module. 




2391




 





 





 





 





 





 



   




2392




 





 





 





 





 





 



 B 




2393




 





 





 





 





 





 



   




2394




 





 





 





 





 





 



   package MyModel::book; 




2395




 





 





 





 





 





 



   use MyModel -base; 




2396




 





 





 





 





 





 



    




2397




 





 





 





 





 





 



   1; 




2398




 





 





 





 





 





 



   




2399




 





 





 





 





 





 



 B 




2400




 





 





 





 





 





 



   




2401




 





 





 





 





 





 



   package MyModel::company; 




2402




 





 





 





 





 





 



   use MyModel -base; 




2403




 





 





 





 





 





 



    




2404




 





 





 





 





 





 



   1; 




2405




 





 





 





 





 





 



    




2406




 





 





 





 





 





 



 MyModel::book and MyModel::company is included by C. 




2407




 





 





 





 





 





 



   




2408




 





 





 





 





 





 



 You can get model object by C. 




2409




 





 





 





 





 





 



   




2410




 





 





 





 





 





 



   my $book_model = $dbi->model('book'); 




2411




 





 





 





 





 





 



   my $company_model = $dbi->model('company'); 




2412




 





 





 





 





 





 



   




2413




 





 





 





 





 





 



 You can include full-qualified table name like C 




2414




 





 





 





 





 





 



   




2415




 





 





 





 





 





 



   lib / MyModel.pm 




2416




 





 





 





 





 





 



       / MyModel / main / book.pm 




2417




 





 





 





 





 





 



                        / company.pm 




2418




 





 





 





 





 





 



   




2419




 





 





 





 





 





 



   my $main_book = $self->model('main.book'); 




2420




 





 





 





 





 





 



   




2421




 





 





 





 





 





 



 See L to know model features. 




2422




 





 





 





 





 





 



   




2423




 





 





 





 





 





 



 =head2 like_value 




2424




 





 





 





 





 





 



   




2425




 





 





 





 





 





 



   my $like_value = $dbi->like_value 




2426




 





 





 





 





 





 



   




2427




 





 





 





 





 





 



 Code reference which return a value for the like value. 




2428




 





 





 





 





 





 



   




2429




 





 





 





 





 





 



   sub { "%$_[0]%" } 




2430




 





 





 





 





 





 



   




2431




 





 





 





 





 





 



 =head2 mapper 




2432




 





 





 





 





 





 



   




2433




 





 





 





 





 





 



   my $mapper = $dbi->mapper(param => $param); 




2434




 





 





 





 





 





 



   




2435




 





 





 





 





 





 



 Create a new L object. 




2436




 





 





 





 





 





 



   




2437




 





 





 





 





 





 



 =head2 merge_param 




2438




 





 





 





 





 





 



   




2439




 





 





 





 





 





 



   my $param = $dbi->merge_param({key1 => 1}, {key1 => 1, key2 => 2}); 




2440




 





 





 





 





 





 



   




2441




 





 





 





 





 





 



 Merge parameters. The following new parameter is created. 




2442




 





 





 





 





 





 



   




2443




 





 





 





 





 





 



   {key1 => [1, 1], key2 => 2} 




2444




 





 





 





 





 





 



   




2445




 





 





 





 





 





 



 If same keys contains, the value is converted to array reference. 




2446




 





 





 





 





 





 



   




2447




 





 





 





 





 





 



 =head2 model 




2448




 





 





 





 





 





 



   




2449




 





 





 





 





 





 



   my $model = $dbi->model('book'); 




2450




 





 





 





 





 





 



   




2451




 





 





 





 





 





 



 Get a L object 




2452




 





 





 





 





 





 



 create by C or C 




2453




 





 





 





 





 





 



   




2454




 





 





 





 





 





 



 =head2 mycolumn 




2455




 





 





 





 





 





 



   




2456




 





 





 





 





 





 



   my $column = $dbi->mycolumn(book => ['author', 'title']); 




2457




 





 





 





 





 





 



   




2458




 





 





 





 





 





 



 Create column clause for myself. The following column clause is created. 




2459




 





 





 





 





 





 



   




2460




 





 





 





 





 





 



   book.author as author, 




2461




 





 





 





 





 





 



   book.title as title 




2462




 





 





 





 





 





 



   




2463




 





 





 





 





 





 



 =head2 new 




2464




 





 





 





 





 





 



   




2465




 





 





 





 





 





 



   my $dbi = DBIx::Custom->new( 




2466




 





 





 





 





 





 



     dsn => "dbi:mysql:database=dbname", 




2467




 





 





 





 





 





 



     user => 'ken', 




2468




 





 





 





 





 





 



     password => '!LFKD%$&', 




2469




 





 





 





 





 





 



     option => {mysql_enable_utf8 => 1} 




2470




 





 





 





 





 





 



   ); 




2471




 





 





 





 





 





 



   




2472




 





 





 





 





 





 



 Create a new L object. 




2473




 





 





 





 





 





 



   




2474




 





 





 





 





 





 



 =head2 not_exists 




2475




 





 





 





 





 





 



   




2476




 





 





 





 





 





 



   my $not_exists = $dbi->not_exists; 




2477




 





 





 





 





 





 



   




2478




 





 





 





 





 





 



 DBIx::Custom::NotExists object, indicating the column is not exists. 




2479




 





 





 





 





 





 



 This is used in C of L . 




2480




 





 





 





 





 





 



   




2481




 





 





 





 





 





 



 =head2 order 




2482




 





 





 





 





 





 



   




2483




 





 





 





 





 





 



   my $order = $dbi->order; 




2484




 





 





 





 





 





 



   




2485




 





 





 





 





 





 



 Create a new L object. 




2486




 





 





 





 





 





 



   




2487




 





 





 





 





 





 



 =head2 q 




2488




 





 





 





 





 





 



   




2489




 





 





 





 





 





 



   my $quooted = $dbi->q("title"); 




2490




 





 





 





 





 





 



   




2491




 





 





 





 





 





 



 Quote string by value of C. 




2492




 





 





 





 





 





 



   




2493




 





 





 





 





 





 



 =head2 register_filter 




2494




 





 





 





 





 





 



   




2495




 





 





 





 





 





 



   $dbi->register_filter( 




2496




 





 





 





 





 





 



     # Time::Piece object to database DATE format 




2497




 





 





 





 





 





 



     tp_to_date => sub { 




2498




 





 





 





 





 





 



       my $tp = shift; 




2499




 





 





 





 





 





 



       return $tp->strftime('%Y-%m-%d'); 




2500




 





 





 





 





 





 



     }, 




2501




 





 





 





 





 





 



     # database DATE format to Time::Piece object 




2502




 





 





 





 





 





 



     date_to_tp => sub { 




2503




 





 





 





 





 





 



       my $date = shift; 




2504




 





 





 





 





 





 



       return Time::Piece->strptime($date, '%Y-%m-%d'); 




2505




 





 





 





 





 





 



     } 




2506




 





 





 





 





 





 



   ); 




2507




 





 





 





 





 





 



    




2508




 





 





 





 





 





 



 Register filters, used by C option of many methods. 




2509




 





 





 





 





 





 



   




2510




 





 





 





 





 





 



 =head2 select 




2511




 





 





 





 





 





 



   




2512




 





 





 





 





 





 



   my $result = $dbi->select( 




2513




 





 





 





 





 





 



     column => ['author', 'title'], 




2514




 





 





 





 





 





 



     table  => 'book', 




2515




 





 





 





 





 





 



     where  => {author => 'Ken'}, 




2516




 





 





 





 





 





 



   ); 




2517




 





 





 





 





 





 



    




2518




 





 





 





 





 





 



 Execute select statement. 




2519




 





 





 





 





 





 



   




2520




 





 





 





 





 





 



 You can pass odd number arguments. first argument is C. 




2521




 





 





 





 





 





 



   




2522




 





 





 





 





 





 



   my $result = $dbi->select(['author', 'title'], table => 'book'); 




2523




 





 





 





 





 





 



   




2524




 





 





 





 





 





 



 B 




2525




 





 





 





 





 





 



   




2526




 





 





 





 





 





 



 C method use all of C method's options, 




2527




 





 





 





 





 





 



 and use the following new ones. 




2528




 





 





 





 





 





 



   




2529




 





 





 





 





 





 



 =over 4 




2530




 





 





 





 





 





 



   




2531




 





 





 





 





 





 



 =item column 




2532




 





 





 





 





 





 



    




2533




 





 





 





 





 





 



   column => 'author' 




2534




 





 





 





 





 





 



   column => ['author', 'title'] 




2535




 





 





 





 





 





 



   




2536




 





 





 





 





 





 



 Column clause. 




2537




 





 





 





 





 





 



    




2538




 





 





 





 





 





 



 if C is not specified, '*' is set. 




2539




 





 





 





 





 





 



   




2540




 





 





 





 





 





 



   column => '*' 




2541




 





 





 





 





 





 



   




2542




 





 





 





 





 





 



 You can specify hash of array reference. 




2543




 





 





 





 





 





 



   




2544




 





 





 





 





 





 



   column => [ 




2545




 





 





 





 





 





 



     {book => [qw/author title/]}, 




2546




 





 





 





 





 





 



     {person => [qw/name age/]} 




2547




 





 





 





 





 





 



   ] 




2548




 





 





 





 





 





 



   




2549




 





 





 





 





 





 



 This is expanded to the following one by using C method. 




2550




 





 





 





 





 





 



   




2551




 





 





 





 





 





 



   book.author as "book.author", 




2552




 





 





 





 





 





 



   book.title as "book.title", 




2553




 





 





 





 





 





 



   person.name as "person.name", 




2554




 





 





 





 





 





 



   person.age as "person.age" 




2555




 





 





 





 





 





 



   




2556




 





 





 





 





 





 



 You can specify own column by C<__MY__>. 




2557




 





 





 





 





 





 



   




2558




 





 





 





 





 





 



   column => [ 




2559




 





 





 





 





 





 



     {__MY__ => [qw/author title/]}, 




2560




 





 





 





 





 





 



   ] 




2561




 





 





 





 





 





 



   




2562




 





 





 





 





 





 



 This is expanded to the following one by using C method. 




2563




 





 





 





 





 





 



   




2564




 





 





 





 





 





 



   book.author as "author", 




2565




 





 





 





 





 





 



   book.title as "title", 




2566




 





 





 





 





 





 



   




2567




 





 





 





 





 





 



 C<__MY__> can be changed by C attribute. 




2568




 





 





 





 





 





 



   




2569




 





 





 





 





 





 



 =item param 




2570




 





 





 





 





 





 



   




2571




 





 





 





 





 





 



   param => {'table2.key3' => 5} 




2572




 





 





 





 





 





 



   




2573




 





 





 





 





 





 



 Parameter shown before where clause. 




2574




 





 





 





 





 





 



    




2575




 





 





 





 





 





 



 For example, if you want to contain named placeholder in join clause,  




2576




 





 





 





 





 





 



 you can pass parameter by C option. 




2577




 





 





 





 





 





 



   




2578




 





 





 





 





 





 



   join  => ['inner join (select * from table2 where table2.key3 = :table2.key3)' .  




2579




 





 





 





 





 





 



             ' as table2 on table1.key1 = table2.key1'] 




2580




 





 





 





 





 





 



   




2581




 





 





 





 





 





 



 =item prefix 




2582




 





 





 





 





 





 



   




2583




 





 





 





 





 





 



   prefix => 'SQL_CALC_FOUND_ROWS' 




2584




 





 





 





 





 





 



   




2585




 





 





 





 





 





 



 Prefix of column clause 




2586




 





 





 





 





 





 



   




2587




 





 





 





 





 





 



   select SQL_CALC_FOUND_ROWS title, author from book; 




2588




 





 





 





 





 





 



   




2589




 





 





 





 





 





 



 =item join 




2590




 





 





 





 





 





 



   




2591




 





 





 





 





 





 



   join => [ 




2592




 





 





 





 





 





 



     'left outer join company on book.company_id = company_id', 




2593




 





 





 





 





 





 



     'left outer join location on company.location_id = location.id' 




2594




 





 





 





 





 





 



   ] 




2595




 





 





 





 





 





 



        




2596




 





 





 





 





 





 



 Join clause. If column clause or where clause contain table name like "company.name", 




2597




 





 





 





 





 





 



 join clauses needed when SQL is created is used automatically. 




2598




 





 





 





 





 





 



   




2599




 





 





 





 





 





 



   $dbi->select( 




2600




 





 





 





 





 





 



     table => 'book', 




2601




 





 





 





 





 





 



     column => ['company.location_id as location_id'], 




2602




 





 





 





 





 





 



     where => {'company.name' => 'Orange'}, 




2603




 





 





 





 





 





 



     join => [ 




2604




 





 





 





 





 





 



       'left outer join company on book.company_id = company.id', 




2605




 





 





 





 





 





 



       'left outer join location on company.location_id = location.id' 




2606




 





 





 





 





 





 



     ] 




2607




 





 





 





 





 





 



   ); 




2608




 





 





 





 





 





 



   




2609




 





 





 





 





 





 



 In above select, column and where clause contain "company" table, 




2610




 





 





 





 





 





 



 the following SQL is created 




2611




 





 





 





 





 





 



   




2612




 





 





 





 





 





 



   select company.location_id as location_id 




2613




 





 





 





 





 





 



   from book 




2614




 





 





 





 





 





 



     left outer join company on book.company_id = company.id 




2615




 





 





 





 





 





 



   where company.name = ?; 




2616




 





 





 





 





 





 



   




2617




 





 





 





 





 





 



 You can specify two table by yourself. This is useful when join parser can't parse 




2618




 





 





 





 





 





 



 the join clause correctly. 




2619




 





 





 





 





 





 



   




2620




 





 





 





 





 





 



   $dbi->select( 




2621




 





 





 





 





 





 



     table => 'book', 




2622




 





 





 





 





 





 



     column => ['company.location_id as location_id'], 




2623




 





 





 





 





 





 



     where => {'company.name' => 'Orange'}, 




2624




 





 





 





 





 





 



     join => [ 




2625




 





 





 





 





 





 



       { 




2626




 





 





 





 





 





 



         clause => 'left outer join location on company.location_id = location.id', 




2627




 





 





 





 





 





 



         table => ['company', 'location'] 




2628




 





 





 





 





 





 



       } 




2629




 





 





 





 





 





 



     ] 




2630




 





 





 





 





 





 



   ); 




2631




 





 





 





 





 





 



   




2632




 





 





 





 





 





 



 =item table 




2633




 





 





 





 





 





 



   




2634




 





 





 





 





 





 



   table => 'book' 




2635




 





 





 





 





 





 



   




2636




 





 





 





 





 





 



 Table name. 




2637




 





 





 





 





 





 



   




2638




 





 





 





 





 





 



 =item where 




2639




 





 





 





 





 





 



    




2640




 





 





 





 





 





 



   # (1) Hash reference 




2641




 





 





 





 





 





 



   where => {author => 'Ken', 'title' => ['Perl', 'Ruby']} 




2642




 





 





 





 





 





 



   # -> where author = 'Ken' and title in ('Perl', 'Ruby') 




2643




 





 





 





 





 





 



    




2644




 





 





 





 





 





 



   # (2) DBIx::Custom::Where object 




2645




 





 





 





 





 





 



   where => $dbi->where( 




2646




 





 





 





 





 





 



     clause => ['and', ':author{=}', ':title{like}'], 




2647




 





 





 





 





 





 



     param  => {author => 'Ken', title => '%Perl%'} 




2648




 





 





 





 





 





 



   ) 




2649




 





 





 





 





 





 



   # -> where author = 'Ken' and title like '%Perl%' 




2650




 





 





 





 





 





 



    




2651




 





 





 





 





 





 



   # (3) Array reference[where clause, parameters, join(optional)] 




2652




 





 





 





 





 





 



   where => [ 




2653




 





 





 





 





 





 



     ['and', ':author{=}', ':title{like}'], 




2654




 





 





 





 





 





 



     {author => 'Ken', title => '%Perl%'}, 




2655




 





 





 





 





 





 



     ["left outer join table2 on table1.key1 = table2.key1"] 




2656




 





 





 





 





 





 



   ] 




2657




 





 





 





 





 





 



   # -> where author = 'Ken' and title like '%Perl%' 




2658




 





 





 





 





 





 



    




2659




 





 





 





 





 





 



   # (4) Array reference[String, Hash reference] 




2660




 





 





 





 





 





 



   where => [ 




2661




 





 





 





 





 





 



     ':author{=} and :title{like}', 




2662




 





 





 





 





 





 



     {author => 'Ken', title => '%Perl%'} 




2663




 





 





 





 





 





 



   ] 




2664




 





 





 





 





 





 



   #  -> where author = 'Ken' and title like '%Perl%' 




2665




 





 





 





 





 





 



    




2666




 





 





 





 





 





 



   # (5) String 




2667




 





 





 





 





 





 



   where => 'title is null' 




2668




 





 





 





 





 





 



   #  -> where title is null 




2669




 





 





 





 





 





 



   




2670




 





 





 





 





 





 



 Where clause. 




2671




 





 





 





 





 





 



 See also L to know how to create where clause. 




2672




 





 





 





 





 





 



    




2673




 





 





 





 





 





 



 =back 




2674




 





 





 





 





 





 



   




2675




 





 





 





 





 





 



 =head2 type_rule 




2676




 





 





 





 





 





 



   




2677




 





 





 





 





 





 



   $dbi->type_rule( 




2678




 





 





 





 





 





 



     into1 => { 




2679




 





 





 





 





 





 



       date => sub { ... }, 




2680




 





 





 





 





 





 



       datetime => sub { ... } 




2681




 





 





 





 





 





 



     }, 




2682




 





 





 





 





 





 



     into2 => { 




2683




 





 





 





 





 





 



       date => sub { ... }, 




2684




 





 





 





 





 





 



       datetime => sub { ... } 




2685




 





 





 





 





 





 



     }, 




2686




 





 





 





 





 





 



     from1 => { 




2687




 





 





 





 





 





 



       # DATE 




2688




 





 





 





 





 





 



       9 => sub { ... }, 




2689




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2690




 





 





 





 





 





 



       11 => sub { ... }, 




2691




 





 





 





 





 





 



     } 




2692




 





 





 





 





 





 



     from2 => { 




2693




 





 





 





 





 





 



       # DATE 




2694




 





 





 





 





 





 



       9 => sub { ... }, 




2695




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2696




 





 





 





 





 





 



       11 => sub { ... }, 




2697




 





 





 





 





 





 



     } 




2698




 





 





 





 





 





 



   ); 




2699




 





 





 





 





 





 



   




2700




 





 





 





 





 





 



 Filtering rule when data is send into and get from database. 




2701




 





 





 





 





 





 



 This has a little complex problem. 




2702




 





 





 





 





 





 



   




2703




 





 





 





 





 





 



 In C and C you can specify 




2704




 





 





 





 





 





 



 type name as same as type name defined 




2705




 





 





 





 





 





 



 by create table, such as C or C. 




2706




 





 





 





 





 





 



   




2707




 





 





 





 





 





 



 Note that type name and data type don't contain upper case. 




2708




 





 





 





 





 





 



 If these contain upper case character, you convert it to lower case. 




2709




 





 





 





 





 





 



   




2710




 





 





 





 





 





 



 C is executed after C. 




2711




 





 





 





 





 





 



   




2712




 





 





 





 





 





 



 Type rule of C and C is enabled on the following 




2713




 





 





 





 





 





 



 column name. 




2714




 





 





 





 





 





 



   




2715




 





 





 





 





 





 



 =over 4 




2716




 





 





 





 





 





 



   




2717




 





 





 





 





 





 



 =item 1. column name 




2718




 





 





 





 





 





 



   




2719




 





 





 





 





 





 



   issue_date 




2720




 





 





 





 





 





 



   issue_datetime 




2721




 





 





 





 





 





 



   




2722




 





 





 





 





 





 



 This need C option in each method. 




2723




 





 





 





 





 





 



   




2724




 





 





 





 





 





 



 =item 2. table name and column name, separator is dot 




2725




 





 





 





 





 





 



   




2726




 





 





 





 





 





 



   book.issue_date 




2727




 





 





 





 





 





 



   book.issue_datetime 




2728




 





 





 





 





 





 



   




2729




 





 





 





 





 





 



 =back 




2730




 





 





 





 





 





 



   




2731




 





 





 





 





 





 



 You get all type name used in database by C. 




2732




 





 





 





 





 





 



   




2733




 





 





 





 





 





 



   print $dbi->available_typename; 




2734




 





 





 





 





 





 



   




2735




 





 





 





 





 





 



 In C and C you specify data type, not type name. 




2736




 





 





 





 





 





 



 C is executed after C. 




2737




 





 





 





 





 





 



 You get all data type by C. 




2738




 





 





 





 





 





 



   




2739




 





 





 





 





 





 



   print $dbi->available_datatype; 




2740




 





 





 





 





 





 



   




2741




 





 





 





 





 





 



 You can also specify multiple types at once. 




2742




 





 





 





 





 





 



   




2743




 





 





 





 





 





 



   $dbi->type_rule( 




2744




 





 





 





 





 





 



     into1 => [ 




2745




 





 





 





 





 





 



       [qw/DATE DATETIME/] => sub { ... }, 




2746




 





 





 





 





 





 



     ], 




2747




 





 





 





 





 





 



   ); 




2748




 





 





 





 





 





 



   




2749




 





 





 





 





 





 



 =head2 update 




2750




 





 





 





 





 





 



   




2751




 





 





 





 





 





 



   $dbi->update({title => 'Perl'}, table  => 'book', where  => {id => 4}); 




2752




 





 





 





 





 





 



   




2753




 





 





 





 





 





 



 Execute update statement. First argument is update row data. 




2754




 





 





 





 





 





 



   




2755




 





 





 





 





 





 



 If you want to set constant value to row data, use scalar reference 




2756




 





 





 





 





 





 



 as parameter value. 




2757




 





 





 





 





 





 



   




2758




 





 





 





 





 





 



   {date => \"NOW()"} 




2759




 





 





 





 





 





 



   




2760




 





 





 





 





 





 



 B 




2761




 





 





 





 





 





 



   




2762




 





 





 





 





 





 



 C method use all of C method's options, 




2763




 





 





 





 





 





 



 and use the following new ones. 




2764




 





 





 





 





 





 



   




2765




 





 





 





 





 





 



 =over 4 




2766




 





 





 





 





 





 



   




2767




 





 





 





 





 





 



 =item prefix 




2768




 





 





 





 





 





 



   




2769




 





 





 





 





 





 



   prefix => 'or replace' 




2770




 





 





 





 





 





 



   




2771




 





 





 





 





 





 



 prefix before table name section 




2772




 





 





 





 





 





 



   




2773




 





 





 





 





 





 



   update or replace book 




2774




 





 





 





 





 





 



   




2775




 





 





 





 





 





 



 =item table 




2776




 





 





 





 





 





 



   




2777




 





 





 





 





 





 



   table => 'book' 




2778




 





 





 





 





 





 



   




2779




 





 





 





 





 





 



 Table name. 




2780




 





 





 





 





 





 



   




2781




 





 





 





 





 





 



 =item where 




2782




 





 





 





 





 





 



   




2783




 





 





 





 





 





 



 Same as C method's C option. 




2784




 





 





 





 





 





 



   




2785




 





 





 





 





 





 



 =item wrap 




2786




 





 





 





 





 





 



   




2787




 





 





 





 





 





 



   wrap => {price => sub { "max($_[0])" }} 




2788




 





 





 





 





 





 



   




2789




 





 





 





 





 





 



 placeholder wrapped string. 




2790




 





 





 





 





 





 



   




2791




 





 





 





 





 





 



 If the following statement 




2792




 





 





 





 





 





 



   




2793




 





 





 





 





 





 



   $dbi->update({price => 100}, table => 'book', 




2794




 





 





 





 





 





 



     {price => sub { "$_[0] + 5" }}); 




2795




 





 





 





 





 





 



   




2796




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2797




 





 





 





 





 





 



   




2798




 





 





 





 





 





 



   update book set price =  ? + 5; 




2799




 





 





 





 





 





 



   




2800




 





 





 





 





 





 



 =item mtime 




2801




 





 





 





 





 





 



   




2802




 





 





 





 





 





 



   mtime => 'modified_time' 




2803




 





 





 





 





 





 



   




2804




 





 





 





 





 





 



 Modified time column name. time row is updated is set to the column. 




2805




 





 





 





 





 





 



 default time format is C, which can be changed by 




2806




 





 





 





 





 





 



 C attribute. 




2807




 





 





 





 





 





 



   




2808




 





 





 





 





 





 



 =back 




2809




 





 





 





 





 





 



   




2810




 





 





 





 





 





 



 =head2 update_all 




2811




 





 





 





 





 





 



   




2812




 





 





 





 





 





 



   $dbi->update_all({title => 'Perl'}, table => 'book', ); 




2813




 





 





 





 





 





 



   




2814




 





 





 





 





 





 



 Execute update statement for all rows. 




2815




 





 





 





 





 





 



 Options is same as C method. 




2816




 





 





 





 





 





 



   




2817




 





 





 





 





 





 



 =over 4 




2818




 





 





 





 





 





 



   




2819




 





 





 





 





 





 



 =item option 




2820




 





 





 





 





 





 



   




2821




 





 





 





 





 





 



   option => { 




2822




 





 





 





 





 





 



     select => { 




2823




 





 





 





 





 





 



       append => '...' 




2824




 





 





 





 





 





 



     }, 




2825




 





 





 





 





 





 



     insert => { 




2826




 





 





 





 





 





 



       prefix => '...' 




2827




 





 





 





 





 





 



     }, 




2828




 





 





 





 





 





 



     update => { 




2829




 





 





 





 





 





 



       filter => {} 




2830




 





 





 





 





 





 



     } 




2831




 





 





 





 





 





 



   } 




2832




 





 





 





 





 





 



   




2833




 





 





 





 





 





 



 If you want to pass option to each method, 




2834




 





 





 





 





 





 



 you can use C option. 




2835




 





 





 





 





 





 



   




2836




 





 





 





 





 





 



 =over 4 




2837




 





 





 





 





 





 



   




2838




 





 





 





 





 





 



 =item select_option 




2839




 





 





 





 





 





 



   




2840




 





 





 





 





 





 



   select_option => {append => 'for update'} 




2841




 





 





 





 





 





 



   




2842




 





 





 





 





 





 



 select method option, 




2843




 





 





 





 





 





 



 select method is used to check the row is already exists. 




2844




 





 





 





 





 





 



   




2845




 





 





 





 





 





 



 =head2 show_datatype 




2846




 





 





 





 





 





 



   




2847




 





 





 





 





 





 



   $dbi->show_datatype($table); 




2848




 





 





 





 





 





 



   




2849




 





 





 





 





 





 



 Show data type of the columns of specified table. 




2850




 





 





 





 





 





 



   




2851




 





 





 





 





 





 



   book 




2852




 





 





 





 





 





 



   title: 5 




2853




 





 





 





 





 





 



   issue_date: 91 




2854




 





 





 





 





 





 



   




2855




 





 





 





 





 





 



 This data type is used in C's C and C. 




2856




 





 





 





 





 





 



   




2857




 





 





 





 





 





 



 =head2 show_tables 




2858




 





 





 





 





 





 



   




2859




 





 





 





 





 





 



   $dbi->show_tables; 




2860




 





 





 





 





 





 



   




2861




 





 





 





 





 





 



 Show tables. 




2862




 





 





 





 





 





 



   




2863




 





 





 





 





 





 



 =head2 show_typename 




2864




 





 





 





 





 





 



   




2865




 





 





 





 





 





 



   $dbi->show_typename($table); 




2866




 





 





 





 





 





 



   




2867




 





 





 





 





 





 



 Show type name of the columns of specified table. 




2868




 





 





 





 





 





 



   




2869




 





 





 





 





 





 



   book 




2870




 





 





 





 





 





 



   title: varchar 




2871




 





 





 





 





 





 



   issue_date: date 




2872




 





 





 





 





 





 



   




2873




 





 





 





 





 





 



 This type name is used in C's C and C. 




2874




 





 





 





 





 





 



   




2875




 





 





 





 





 





 



 =head2 values_clause 




2876




 





 





 





 





 





 



   




2877




 





 





 





 





 





 



   my $values_clause = $dbi->values_clause({title => 'a', age => 2}); 




2878




 





 





 





 





 





 



   




2879




 





 





 





 





 





 



 Create values clause. 




2880




 





 





 





 





 





 



   




2881




 





 





 





 





 





 



   (title, author) values (title = :title, age = :age); 




2882




 





 





 





 





 





 



   




2883




 





 





 





 





 





 



 You can use this in insert statement. 




2884




 





 





 





 





 





 



   




2885




 





 





 





 





 





 



   my $insert_sql = "insert into book $values_clause"; 




2886




 





 





 





 





 





 



   




2887




 





 





 





 





 





 



 =head2 where 




2888




 





 





 





 





 





 



   




2889




 





 





 





 





 





 



   my $where = $dbi->where; 




2890




 





 





 





 





 





 



   $where->clause(['and', 'title = :title', 'author = :author']); 




2891




 





 





 





 





 





 



   $where->param({title => 'Perl', author => 'Ken'}); 




2892




 





 





 





 





 





 



   $where->join(['left join author on book.author = author.id]); 




2893




 





 





 





 





 





 



   




2894




 





 





 





 





 





 



 Create a new L object. 




2895




 





 





 





 





 





 



 See L to know how to create where clause. 




2896




 





 





 





 





 





 



   




2897




 





 





 





 





 





 



 =head1 ENVIRONMENTAL VARIABLES 




2898




 





 





 





 





 





 



   




2899




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG 




2900




 





 





 





 





 





 



   




2901




 





 





 





 





 





 



 If environment variable C is set to true, 




2902




 





 





 





 





 





 



 executed SQL and bind values are printed to STDERR. 




2903




 





 





 





 





 





 



   




2904




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG_ENCODING 




2905




 





 





 





 





 





 



   




2906




 





 





 





 





 





 



 DEBUG output encoding. Default to UTF-8. 




2907




 





 





 





 





 





 



   




2908




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION 




2909




 





 





 





 





 





 



   




2910




 





 





 





 





 





 



   $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25'; 




2911




 





 





 





 





 





 



   




2912




 





 





 





 





 





 



 Suppress deprecation warnings before specified version. 




2913




 





 





 





 





 





 



   




2914




 





 





 





 





 





 



 =head1 DEPRECATED FUNCTIONALITY 




2915




 





 





 





 





 





 



   




2916




 





 





 





 





 





 



 L 




2917




 





 





 





 





 





 



   




2918




 





 





 





 





 





 



   # Methods 




2919




 





 





 





 





 





 



   DBIx::Custom AUTOLOAD feature # will be removed at 2022/5/1 




2920




 





 





 





 





 





 



   DBIx::Custom::helper method # will be removed at 2022/5/1 




2921




 





 





 





 





 





 



   DBIx::Custom::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1 




2922




 





 





 





 





 





 



   DBIx::Custom::count method # will be removed at 2022/5/1 




2923




 





 





 





 





 





 



   DBIx::Custom::select,update,delete method's primary_key option is DEPRECATED! # will be removed at 2022/5/1 




2924




 





 





 





 





 





 



   DBIx::Custom::select,update,delete method's id option is DEPRECATED! # will be removed at 2022/5/1 




2925




 





 





 





 





 





 



   DBIx::Custom::setup method is DEPRECATED! # will be removed at 2022/5/1 




2926




 





 





 





 





 





 



   




2927




 





 





 





 





 





 



 L 




2928




 





 





 





 





 





 



    




2929




 





 





 





 





 





 



   # Options 




2930




 





 





 





 





 





 



   kv method's multi option (from 0.28) # will be removed at 2018/3/1 




2931




 





 





 





 





 





 



   




2932




 





 





 





 





 





 



 L 




2933




 





 





 





 





 





 



   




2934




 





 





 





 





 





 



   DBIx::Custom::Model AUTOLOAD feature # will be removed at 2022/5/1 




2935




 





 





 





 





 





 



   DBIx::Custom::Model::helper method is DEPRECATED! # will be removed at 2022/5/1 




2936




 





 





 





 





 





 



   DBIx::Custom::Model::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1 




2937




 





 





 





 





 





 



   DBIx::Custom::Model::count method # will be removed at 2022/5/1 




2938




 





 





 





 





 





 



   DBIx::Custom::Model::primary_key attribute is DEPRECATED! # will be removed at 2022/5/1 




2939




 





 





 





 





 





 



   




2940




 





 





 





 





 





 



 =head1 BACKWARDS COMPATIBILITY POLICY 




2941




 





 





 





 





 





 



   




2942




 





 





 





 





 





 



 If a feature is DEPRECATED, you can know it by DEPRECATED warnings. 




2943




 





 





 





 





 





 



 DEPRECATED feature is removed after C, 




2944




 





 





 





 





 





 



 but if at least one person use the feature and tell me that thing 




2945




 





 





 





 





 





 



 I extend one year each time he tell me it. 




2946




 





 





 





 





 





 



   




2947




 





 





 





 





 





 



 DEPRECATION warnings can be suppressed by C 




2948




 





 





 





 





 





 



 environment variable. 




2949




 





 





 





 





 





 



   




2950




 





 





 





 





 





 



 EXPERIMENTAL features will be changed or deleted without warnings. 




2951




 





 





 





 





 





 



   




2952




 





 





 





 





 





 



 =head1 BUGS 




2953




 





 





 





 





 





 



   




2954




 





 





 





 





 





 



 Please tell me bugs if you find bug. 




2955




 





 





 





 





 





 



   




2956




 





 





 





 





 





 



 C<<  >> 




2957




 





 





 





 





 





 



   




2958




 





 





 





 





 





 



 L 




2959




 





 





 





 





 





 



   




2960




 





 





 





 





 





 



 =head1 AUTHOR 




2961




 





 





 





 





 





 



   




2962




 





 





 





 





 





 



 Yuki Kimoto, C<<  >> 




2963




 





 





 





 





 





 



   




2964




 





 





 





 





 





 



 =head1 COPYRIGHT & LICENSE 




2965




 





 





 





 





 





 



   




2966




 





 





 





 





 





 



 Copyright 2009-2019 Yuki Kimoto, all rights reserved. 




2967




 





 





 





 





 





 



   




2968




 





 





 





 





 





 



 This program is free software; you can redistribute it and/or modify it 




2969




 





 





 





 





 





 



 under the same terms as Perl itself. 




2970




 





 





 





 





 





 



   




2971




 





 





 





 





 





 



 =cut
C. 




2082




 





 





 





 





 





 



   




2083




 





 





 





 





 





 



 If C is set, C method use C 




2084




 





 





 





 





 





 



 information, you can improve the performance of C in 




2085




 





 





 





 





 





 



 the following way. 




2086




 





 





 





 





 





 



   




2087




 





 





 





 





 





 



   my $table_infos = $dbi->get_table_info(exclude => qr/^system_/); 




2088




 





 





 





 





 





 



   $dbi->user_table_info($table_info); 




2089




 





 





 





 





 





 



   $dbi->each_table(sub { ... }); 




2090




 





 





 





 





 





 



   




2091




 





 





 





 





 





 



 =head2 execute 




2092




 





 





 





 





 





 



   




2093




 





 





 





 





 





 



   my $result = $dbi->execute( 




2094




 





 





 





 





 





 



     "select * from book where title = :title and author like :author", 




2095




 





 





 





 





 





 



     {title => 'Perl', author => '%Ken%'} 




2096




 





 





 





 





 





 



   ); 




2097




 





 





 





 





 





 



   




2098




 





 





 





 





 





 



   my $result = $dbi->execute( 




2099




 





 





 





 





 





 



     "select * from book where title = :book.title and author like :book.author", 




2100




 





 





 





 





 





 



     {'book.title' => 'Perl', 'book.author' => '%Ken%'} 




2101




 





 





 





 





 





 



   ); 




2102




 





 





 





 





 





 



   




2103




 





 





 





 





 





 



 Execute SQL. SQL can contain column parameter such as :author and :title. 




2104




 





 





 





 





 





 



 You can append table name to column name such as :book.title and :book.author. 




2105




 





 





 





 





 





 



 Second argument is data, embedded into column parameter. 




2106




 





 





 





 





 





 



 Return value is L object when select statement is executed, 




2107




 





 





 





 





 





 



 or the count of affected rows when insert, update, delete statement is executed. 




2108




 





 





 





 





 





 



   




2109




 





 





 





 





 





 



 Named placeholder such as C<:title> is replaced by placeholder C. 




2110




 





 





 





 





 





 



    




2111




 





 





 





 





 





 



   # Original 




2112




 





 





 





 





 





 



   select * from book where title = :title and author like :author 




2113




 





 





 





 





 





 



    




2114




 





 





 





 





 





 



   # Replaced 




2115




 





 





 





 





 





 



   select * from where title = ? and author like ?; 




2116




 





 





 





 





 





 



   




2117




 





 





 





 





 





 



 You can specify operator with named placeholder 




2118




 





 





 





 





 





 



 by C syntax. 




2119




 





 





 





 





 





 



   




2120




 





 





 





 





 





 



   # Original 




2121




 





 





 





 





 





 



   select * from book where :title{=} and :author{like} 




2122




 





 





 





 





 





 



    




2123




 





 





 





 





 





 



   # Replaced 




2124




 





 





 





 





 





 



   select * from where title = ? and author like ?; 




2125




 





 





 





 





 





 



   




2126




 





 





 





 





 





 



 Note that colons in time format such as 12:13:15 is an exception, 




2127




 





 





 





 





 





 



 it is not parsed as named placeholder. 




2128




 





 





 





 





 





 



 If you want to use colon generally, you must escape it by C<\\> 




2129




 





 





 





 





 





 



   




2130




 





 





 





 





 





 



   select * from where title = "aa\\:bb"; 




2131




 





 





 





 





 





 



   




2132




 





 





 





 





 





 



 B 




2133




 





 





 





 





 





 



   




2134




 





 





 





 





 





 



 The following options are available. 




2135




 





 





 





 





 





 



   




2136




 





 





 





 





 





 



 =over 4 




2137




 





 





 





 





 





 



   




2138




 





 





 





 





 





 



 =item after_build_sql  




2139




 





 





 





 





 





 



   




2140




 





 





 





 





 





 



 You can filter sql after the sql is build. 




2141




 





 





 





 





 





 



   




2142




 





 





 





 





 





 



   after_build_sql => $code_ref 




2143




 





 





 





 





 





 



   




2144




 





 





 





 





 





 



 The following one is one example. 




2145




 





 





 





 





 





 



   




2146




 





 





 





 





 





 



   $dbi->select( 




2147




 





 





 





 





 





 



     table => 'book', 




2148




 





 





 





 





 





 



     column => 'distinct(name)', 




2149




 





 





 





 





 





 



     after_build_sql => sub { 




2150




 





 





 





 





 





 



       "select count(*) from ($_[0]) as t1" 




2151




 





 





 





 





 





 



     } 




2152




 





 





 





 





 





 



   ); 




2153




 





 





 





 





 





 



   




2154




 





 





 





 





 





 



 The following SQL is executed. 




2155




 





 





 





 





 





 



   




2156




 





 





 





 





 





 



   select count(*) from (select distinct(name) from book) as t1; 




2157




 





 





 





 





 





 



   




2158




 





 





 





 





 





 



 =item append 




2159




 





 





 





 





 





 



   




2160




 





 





 





 





 





 



   append => 'order by name' 




2161




 





 





 





 





 





 



   




2162




 





 





 





 





 





 



 Append some statement after SQL. 




2163




 





 





 





 





 





 



   




2164




 





 





 





 





 





 



 =item bind_type 




2165




 





 





 





 





 





 



   




2166




 





 





 





 





 





 



 Specify database bind data type. 




2167




 





 





 





 





 





 



    




2168




 





 





 





 





 





 



   bind_type => {image => DBI::SQL_BLOB} 




2169




 





 





 





 





 





 



   bind_type => [image => DBI::SQL_BLOB] 




2170




 





 





 





 





 





 



   bind_type => [[qw/image audio/] => DBI::SQL_BLOB] 




2171




 





 





 





 





 





 



   




2172




 





 





 





 





 





 



 This is used to bind parameter by C of statement handle. 




2173




 





 





 





 





 





 



   




2174




 





 





 





 





 





 



   $sth->bind_param($pos, $value, DBI::SQL_BLOB); 




2175




 





 





 





 





 





 



   




2176




 





 





 





 





 





 



 =item filter 




2177




 





 





 





 





 





 



    




2178




 





 





 





 





 





 



   filter => { 




2179




 





 





 





 





 





 



     title  => sub { uc $_[0] } 




2180




 





 





 





 





 





 



     author => sub { uc $_[0] } 




2181




 





 





 





 





 





 



   } 




2182




 





 





 





 





 





 



   




2183




 





 





 





 





 





 



   # Filter name 




2184




 





 





 





 





 





 



   filter => { 




2185




 





 





 





 





 





 



     title  => 'upper_case', 




2186




 





 





 





 





 





 



     author => 'upper_case' 




2187




 





 





 





 





 





 



   } 




2188




 





 





 





 





 





 



        




2189




 





 





 





 





 





 



   # At once 




2190




 





 





 





 





 





 



   filter => [ 




2191




 





 





 





 





 





 



     [qw/title author/]  => sub { uc $_[0] } 




2192




 





 





 





 





 





 



   ] 




2193




 





 





 





 





 





 



   




2194




 





 





 





 





 





 



 Filter. You can set subroutine or filter name 




2195




 





 





 





 





 





 



 registered by C. 




2196




 





 





 





 





 





 



 This filter is executed before data is saved into database. 




2197




 





 





 





 





 





 



 and before type rule filter is executed. 




2198




 





 





 





 





 





 



   




2199




 





 





 





 





 





 



 =item reuse 




2200




 





 





 





 





 





 



    




2201




 





 





 





 





 





 



   reuse => $hash_ref 




2202




 





 





 





 





 





 



   




2203




 





 





 





 





 





 



 Reuse statement handle in same SQL. 




2204




 





 





 





 





 





 



    




2205




 





 





 





 





 





 



   my $reuse = {}; 




2206




 





 





 





 





 





 



   $dbi->execute($sql, $param, reuse => $reuse); 




2207




 





 





 





 





 





 



   




2208




 





 





 





 





 





 



 This will improved performance when you want to execute same sql repeatedly. 




2209




 





 





 





 





 





 



   




2210




 





 





 





 





 





 



 =item table 




2211




 





 





 





 





 





 



    




2212




 





 





 





 





 





 



   table => 'author' 




2213




 





 





 





 





 





 



   




2214




 





 





 





 





 





 



 If you want to omit table name in column name 




2215




 





 





 





 





 





 



 and enable C and C type filter, 




2216




 





 





 





 





 





 



 You must set C option. 




2217




 





 





 





 





 





 



   




2218




 





 





 





 





 





 



   $dbi->execute("select * from book where title = :title and author = :author", 




2219




 





 





 





 





 





 



     {title => 'Perl', author => 'Ken', table => 'book'); 




2220




 





 





 





 





 





 



   




2221




 





 





 





 





 





 



   # Same 




2222




 





 





 





 





 





 



   $dbi->execute( 




2223




 





 





 





 





 





 



     "select * from book where title = :book.title and author = :book.author", 




2224




 





 





 





 





 





 



     {title => 'Perl', author => 'Ken'); 




2225




 





 





 





 





 





 



   




2226




 





 





 





 





 





 



 =item table_alias 




2227




 





 





 





 





 





 



   




2228




 





 





 





 





 





 



   table_alias => {worker => 'user'} # {ALIAS => TABLE} 




2229




 





 





 





 





 





 



   




2230




 





 





 





 





 





 



 Table alias. Key is alias table name, value is real table name, . 




2231




 





 





 





 





 





 



 If you set C, you can enable C and C type rule 




2232




 





 





 





 





 





 



 on alias table name. 




2233




 





 





 





 





 





 



   




2234




 





 





 





 





 





 



 =item type_rule_off 




2235




 





 





 





 





 





 



   




2236




 





 





 





 





 





 



   type_rule_off => 1 




2237




 





 





 





 





 





 



   




2238




 





 





 





 





 





 



 Turn C and C type rule off. 




2239




 





 





 





 





 





 



   




2240




 





 





 





 





 





 



 =item type_rule1_off 




2241




 





 





 





 





 





 



   




2242




 





 





 





 





 





 



   type_rule1_off => 1 




2243




 





 





 





 





 





 



   




2244




 





 





 





 





 





 



 Turn C type rule off. 




2245




 





 





 





 





 





 



   




2246




 





 





 





 





 





 



 =item type_rule2_off 




2247




 





 





 





 





 





 



   




2248




 





 





 





 





 





 



   type_rule2_off => 1 




2249




 





 





 





 





 





 



   




2250




 





 





 





 





 





 



 Turn C type rule off. 




2251




 





 





 





 





 





 



   




2252




 





 





 





 





 





 



 =item prepare_attr 




2253




 





 





 





 





 





 



   




2254




 





 





 





 





 





 



   prepare_attr => {mysql_use_result => 1} 




2255




 





 





 





 





 





 



   




2256




 





 





 





 





 





 



 Statemend handle attributes, 




2257




 





 





 





 





 





 



 this is L's C method second argument. 




2258




 





 





 





 





 





 



   




2259




 





 





 





 





 





 



 =head2 get_column_info 




2260




 





 





 





 





 





 



   




2261




 





 





 





 





 





 



   my $column_infos = $dbi->get_column_info(exclude_table => qr/^system_/); 




2262




 





 





 





 





 





 



   




2263




 





 





 





 





 





 



 get column information except for one which match C pattern. 




2264




 





 





 





 





 





 



   




2265




 





 





 





 





 





 



   [ 




2266




 





 





 





 





 





 



     {table => 'book', column => 'title', info => {...}}, 




2267




 





 





 





 





 





 



     {table => 'author', column => 'name' info => {...}} 




2268




 





 





 





 





 





 



   ] 




2269




 





 





 





 





 





 



   




2270




 





 





 





 





 





 



 =head2 get_table_info 




2271




 





 





 





 





 





 



   




2272




 





 





 





 





 





 



   my $table_infos = $dbi->get_table_info(exclude => qr/^system_/); 




2273




 





 





 





 





 





 



   




2274




 





 





 





 





 





 



 get table information except for one which match C pattern. 




2275




 





 





 





 





 





 



   




2276




 





 





 





 





 





 



   [ 




2277




 





 





 





 





 





 



     {table => 'book', info => {...}}, 




2278




 





 





 





 





 





 



     {table => 'author', info => {...}} 




2279




 





 





 





 





 





 



   ] 




2280




 





 





 





 





 





 



   




2281




 





 





 





 





 





 



 You can set this value to C. 




2282




 





 





 





 





 





 



   




2283




 





 





 





 





 





 



 =head2 insert 




2284




 





 





 





 





 





 



   




2285




 





 





 





 





 





 



   $dbi->insert({title => 'Perl', author => 'Ken'}, table  => 'book'); 




2286




 





 





 





 





 





 



   




2287




 





 





 





 





 





 



 Execute insert statement. First argument is row data. Return value is 




2288




 





 





 





 





 





 



 affected row count. 




2289




 





 





 





 





 





 



   




2290




 





 





 





 





 





 



 If you want to set constant value to row data, use scalar reference 




2291




 





 





 





 





 





 



 as parameter value. 




2292




 





 





 





 





 





 



   




2293




 





 





 





 





 





 



   {date => \"NOW()"} 




2294




 





 





 





 





 





 



   




2295




 





 





 





 





 





 



 You can pass multiple parameters, this is very fast. 




2296




 





 





 





 





 





 



   




2297




 





 





 





 





 





 



   $dbi->insert( 




2298




 





 





 





 





 





 



     [ 




2299




 





 





 





 





 





 



       {title => 'Perl', author => 'Ken'}, 




2300




 





 





 





 





 





 



       {title => 'Ruby', author => 'Tom'} 




2301




 





 





 





 





 





 



     ], 




2302




 





 





 





 





 





 



     table  => 'book' 




2303




 





 





 





 





 





 



   ); 




2304




 





 





 





 





 





 



   




2305




 





 





 





 





 





 



 In multiple insert, you can't use C option. 




2306




 





 





 





 





 





 



 and only first parameter is used to create sql. 




2307




 





 





 





 





 





 



   




2308




 





 





 





 





 





 



 B 




2309




 





 





 





 





 





 



   




2310




 





 





 





 





 





 



 C method use all of C method's options, 




2311




 





 





 





 





 





 



 and use the following new ones. 




2312




 





 





 





 





 





 



   




2313




 





 





 





 





 





 



 =over 4 




2314




 





 





 





 





 





 



   




2315




 





 





 





 





 





 



 =item bulk_insert 




2316




 





 





 





 





 





 



   




2317




 





 





 





 





 





 



   bulk_insert => 1 




2318




 





 





 





 





 





 



   




2319




 





 





 





 





 





 



 bulk insert is executed if database support bulk insert and  




2320




 





 





 





 





 





 



 multiple parameters is passed to C. 




2321




 





 





 





 





 





 



 The SQL like the following one is executed. 




2322




 





 





 





 





 





 



   




2323




 





 





 





 





 





 



   insert into book (id, title) values (?, ?), (?, ?); 




2324




 





 





 





 





 





 



   




2325




 





 





 





 





 





 



 =item ctime 




2326




 





 





 





 





 





 



   




2327




 





 





 





 





 





 



   ctime => 'created_time' 




2328




 





 





 





 





 





 



   




2329




 





 





 





 





 





 



 Created time column name. time when row is created is set to the column. 




2330




 





 





 





 





 





 



 default time format is "YYYY-mm-dd HH:MM:SS", which can be changed by 




2331




 





 





 





 





 





 



 C attribute. 




2332




 





 





 





 





 





 



   




2333




 





 





 





 





 





 



 =item prefix 




2334




 





 





 





 





 





 



   




2335




 





 





 





 





 





 



   prefix => 'or replace' 




2336




 





 





 





 





 





 



   




2337




 





 





 





 





 





 



 prefix before table name section 




2338




 





 





 





 





 





 



   




2339




 





 





 





 





 





 



   insert or replace into book 




2340




 





 





 





 





 





 



   




2341




 





 





 





 





 





 



 =item table 




2342




 





 





 





 





 





 



   




2343




 





 





 





 





 





 



   table => 'book' 




2344




 





 





 





 





 





 



   




2345




 





 





 





 





 





 



 Table name. 




2346




 





 





 





 





 





 



   




2347




 





 





 





 





 





 



 =item mtime 




2348




 





 





 





 





 





 



   




2349




 





 





 





 





 





 



 This option is same as C method C option. 




2350




 





 





 





 





 





 



   




2351




 





 





 





 





 





 



 =item wrap 




2352




 





 





 





 





 





 



   




2353




 





 





 





 





 





 



   wrap => {price => sub { "max($_[0])" }} 




2354




 





 





 





 





 





 



   




2355




 





 





 





 





 





 



 placeholder wrapped string. 




2356




 





 





 





 





 





 



   




2357




 





 





 





 





 





 



 If the following statement 




2358




 





 





 





 





 





 



   




2359




 





 





 





 





 





 



   $dbi->insert({price => 100}, table => 'book', 




2360




 





 





 





 





 





 



     {price => sub { "$_[0] + 5" }}); 




2361




 





 





 





 





 





 



   




2362




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2363




 





 





 





 





 





 



   




2364




 





 





 





 





 





 



   insert into book price values ( ? + 5 ); 




2365




 





 





 





 





 





 



   




2366




 





 





 





 





 





 



 =back 




2367




 





 





 





 





 





 



   




2368




 





 





 





 





 





 



 =over 4 




2369




 





 





 





 





 





 



   




2370




 





 





 





 





 





 



 =head2 include_model 




2371




 





 





 





 





 





 



   




2372




 





 





 





 





 





 



   $dbi->include_model('MyModel'); 




2373




 





 





 





 





 





 



   




2374




 





 





 





 





 





 



 Include models from specified namespace, 




2375




 





 





 





 





 





 



 the following layout is needed to include models. 




2376




 





 





 





 





 





 



   




2377




 





 





 





 





 





 



   lib / MyModel.pm 




2378




 





 





 





 





 





 



       / MyModel / book.pm 




2379




 





 





 





 





 





 



                 / company.pm 




2380




 





 





 





 





 





 



   




2381




 





 





 





 





 





 



 Name space module, extending L. 




2382




 





 





 





 





 





 



   




2383




 





 





 





 





 





 



 B 




2384




 





 





 





 





 





 



   




2385




 





 





 





 





 





 



   package MyModel; 




2386




 





 





 





 





 





 



   use DBIx::Custom::Model -base; 




2387




 





 





 





 





 





 



    




2388




 





 





 





 





 





 



   1; 




2389




 





 





 





 





 





 



   




2390




 





 





 





 





 





 



 Model modules, extending name space module. 




2391




 





 





 





 





 





 



   




2392




 





 





 





 





 





 



 B 




2393




 





 





 





 





 





 



   




2394




 





 





 





 





 





 



   package MyModel::book; 




2395




 





 





 





 





 





 



   use MyModel -base; 




2396




 





 





 





 





 





 



    




2397




 





 





 





 





 





 



   1; 




2398




 





 





 





 





 





 



   




2399




 





 





 





 





 





 



 B 




2400




 





 





 





 





 





 



   




2401




 





 





 





 





 





 



   package MyModel::company; 




2402




 





 





 





 





 





 



   use MyModel -base; 




2403




 





 





 





 





 





 



    




2404




 





 





 





 





 





 



   1; 




2405




 





 





 





 





 





 



    




2406




 





 





 





 





 





 



 MyModel::book and MyModel::company is included by C. 




2407




 





 





 





 





 





 



   




2408




 





 





 





 





 





 



 You can get model object by C. 




2409




 





 





 





 





 





 



   




2410




 





 





 





 





 





 



   my $book_model = $dbi->model('book'); 




2411




 





 





 





 





 





 



   my $company_model = $dbi->model('company'); 




2412




 





 





 





 





 





 



   




2413




 





 





 





 





 





 



 You can include full-qualified table name like C 




2414




 





 





 





 





 





 



   




2415




 





 





 





 





 





 



   lib / MyModel.pm 




2416




 





 





 





 





 





 



       / MyModel / main / book.pm 




2417




 





 





 





 





 





 



                        / company.pm 




2418




 





 





 





 





 





 



   




2419




 





 





 





 





 





 



   my $main_book = $self->model('main.book'); 




2420




 





 





 





 





 





 



   




2421




 





 





 





 





 





 



 See L to know model features. 




2422




 





 





 





 





 





 



   




2423




 





 





 





 





 





 



 =head2 like_value 




2424




 





 





 





 





 





 



   




2425




 





 





 





 





 





 



   my $like_value = $dbi->like_value 




2426




 





 





 





 





 





 



   




2427




 





 





 





 





 





 



 Code reference which return a value for the like value. 




2428




 





 





 





 





 





 



   




2429




 





 





 





 





 





 



   sub { "%$_[0]%" } 




2430




 





 





 





 





 





 



   




2431




 





 





 





 





 





 



 =head2 mapper 




2432




 





 





 





 





 





 



   




2433




 





 





 





 





 





 



   my $mapper = $dbi->mapper(param => $param); 




2434




 





 





 





 





 





 



   




2435




 





 





 





 





 





 



 Create a new L object. 




2436




 





 





 





 





 





 



   




2437




 





 





 





 





 





 



 =head2 merge_param 




2438




 





 





 





 





 





 



   




2439




 





 





 





 





 





 



   my $param = $dbi->merge_param({key1 => 1}, {key1 => 1, key2 => 2}); 




2440




 





 





 





 





 





 



   




2441




 





 





 





 





 





 



 Merge parameters. The following new parameter is created. 




2442




 





 





 





 





 





 



   




2443




 





 





 





 





 





 



   {key1 => [1, 1], key2 => 2} 




2444




 





 





 





 





 





 



   




2445




 





 





 





 





 





 



 If same keys contains, the value is converted to array reference. 




2446




 





 





 





 





 





 



   




2447




 





 





 





 





 





 



 =head2 model 




2448




 





 





 





 





 





 



   




2449




 





 





 





 





 





 



   my $model = $dbi->model('book'); 




2450




 





 





 





 





 





 



   




2451




 





 





 





 





 





 



 Get a L object 




2452




 





 





 





 





 





 



 create by C or C 




2453




 





 





 





 





 





 



   




2454




 





 





 





 





 





 



 =head2 mycolumn 




2455




 





 





 





 





 





 



   




2456




 





 





 





 





 





 



   my $column = $dbi->mycolumn(book => ['author', 'title']); 




2457




 





 





 





 





 





 



   




2458




 





 





 





 





 





 



 Create column clause for myself. The following column clause is created. 




2459




 





 





 





 





 





 



   




2460




 





 





 





 





 





 



   book.author as author, 




2461




 





 





 





 





 





 



   book.title as title 




2462




 





 





 





 





 





 



   




2463




 





 





 





 





 





 



 =head2 new 




2464




 





 





 





 





 





 



   




2465




 





 





 





 





 





 



   my $dbi = DBIx::Custom->new( 




2466




 





 





 





 





 





 



     dsn => "dbi:mysql:database=dbname", 




2467




 





 





 





 





 





 



     user => 'ken', 




2468




 





 





 





 





 





 



     password => '!LFKD%$&', 




2469




 





 





 





 





 





 



     option => {mysql_enable_utf8 => 1} 




2470




 





 





 





 





 





 



   ); 




2471




 





 





 





 





 





 



   




2472




 





 





 





 





 





 



 Create a new L object. 




2473




 





 





 





 





 





 



   




2474




 





 





 





 





 





 



 =head2 not_exists 




2475




 





 





 





 





 





 



   




2476




 





 





 





 





 





 



   my $not_exists = $dbi->not_exists; 




2477




 





 





 





 





 





 



   




2478




 





 





 





 





 





 



 DBIx::Custom::NotExists object, indicating the column is not exists. 




2479




 





 





 





 





 





 



 This is used in C of L . 




2480




 





 





 





 





 





 



   




2481




 





 





 





 





 





 



 =head2 order 




2482




 





 





 





 





 





 



   




2483




 





 





 





 





 





 



   my $order = $dbi->order; 




2484




 





 





 





 





 





 



   




2485




 





 





 





 





 





 



 Create a new L object. 




2486




 





 





 





 





 





 



   




2487




 





 





 





 





 





 



 =head2 q 




2488




 





 





 





 





 





 



   




2489




 





 





 





 





 





 



   my $quooted = $dbi->q("title"); 




2490




 





 





 





 





 





 



   




2491




 





 





 





 





 





 



 Quote string by value of C. 




2492




 





 





 





 





 





 



   




2493




 





 





 





 





 





 



 =head2 register_filter 




2494




 





 





 





 





 





 



   




2495




 





 





 





 





 





 



   $dbi->register_filter( 




2496




 





 





 





 





 





 



     # Time::Piece object to database DATE format 




2497




 





 





 





 





 





 



     tp_to_date => sub { 




2498




 





 





 





 





 





 



       my $tp = shift; 




2499




 





 





 





 





 





 



       return $tp->strftime('%Y-%m-%d'); 




2500




 





 





 





 





 





 



     }, 




2501




 





 





 





 





 





 



     # database DATE format to Time::Piece object 




2502




 





 





 





 





 





 



     date_to_tp => sub { 




2503




 





 





 





 





 





 



       my $date = shift; 




2504




 





 





 





 





 





 



       return Time::Piece->strptime($date, '%Y-%m-%d'); 




2505




 





 





 





 





 





 



     } 




2506




 





 





 





 





 





 



   ); 




2507




 





 





 





 





 





 



    




2508




 





 





 





 





 





 



 Register filters, used by C option of many methods. 




2509




 





 





 





 





 





 



   




2510




 





 





 





 





 





 



 =head2 select 




2511




 





 





 





 





 





 



   




2512




 





 





 





 





 





 



   my $result = $dbi->select( 




2513




 





 





 





 





 





 



     column => ['author', 'title'], 




2514




 





 





 





 





 





 



     table  => 'book', 




2515




 





 





 





 





 





 



     where  => {author => 'Ken'}, 




2516




 





 





 





 





 





 



   ); 




2517




 





 





 





 





 





 



    




2518




 





 





 





 





 





 



 Execute select statement. 




2519




 





 





 





 





 





 



   




2520




 





 





 





 





 





 



 You can pass odd number arguments. first argument is C. 




2521




 





 





 





 





 





 



   




2522




 





 





 





 





 





 



   my $result = $dbi->select(['author', 'title'], table => 'book'); 




2523




 





 





 





 





 





 



   




2524




 





 





 





 





 





 



 B 




2525




 





 





 





 





 





 



   




2526




 





 





 





 





 





 



 C method use all of C method's options, 




2527




 





 





 





 





 





 



 and use the following new ones. 




2528




 





 





 





 





 





 



   




2529




 





 





 





 





 





 



 =over 4 




2530




 





 





 





 





 





 



   




2531




 





 





 





 





 





 



 =item column 




2532




 





 





 





 





 





 



    




2533




 





 





 





 





 





 



   column => 'author' 




2534




 





 





 





 





 





 



   column => ['author', 'title'] 




2535




 





 





 





 





 





 



   




2536




 





 





 





 





 





 



 Column clause. 




2537




 





 





 





 





 





 



    




2538




 





 





 





 





 





 



 if C is not specified, '*' is set. 




2539




 





 





 





 





 





 



   




2540




 





 





 





 





 





 



   column => '*' 




2541




 





 





 





 





 





 



   




2542




 





 





 





 





 





 



 You can specify hash of array reference. 




2543




 





 





 





 





 





 



   




2544




 





 





 





 





 





 



   column => [ 




2545




 





 





 





 





 





 



     {book => [qw/author title/]}, 




2546




 





 





 





 





 





 



     {person => [qw/name age/]} 




2547




 





 





 





 





 





 



   ] 




2548




 





 





 





 





 





 



   




2549




 





 





 





 





 





 



 This is expanded to the following one by using C method. 




2550




 





 





 





 





 





 



   




2551




 





 





 





 





 





 



   book.author as "book.author", 




2552




 





 





 





 





 





 



   book.title as "book.title", 




2553




 





 





 





 





 





 



   person.name as "person.name", 




2554




 





 





 





 





 





 



   person.age as "person.age" 




2555




 





 





 





 





 





 



   




2556




 





 





 





 





 





 



 You can specify own column by C<__MY__>. 




2557




 





 





 





 





 





 



   




2558




 





 





 





 





 





 



   column => [ 




2559




 





 





 





 





 





 



     {__MY__ => [qw/author title/]}, 




2560




 





 





 





 





 





 



   ] 




2561




 





 





 





 





 





 



   




2562




 





 





 





 





 





 



 This is expanded to the following one by using C method. 




2563




 





 





 





 





 





 



   




2564




 





 





 





 





 





 



   book.author as "author", 




2565




 





 





 





 





 





 



   book.title as "title", 




2566




 





 





 





 





 





 



   




2567




 





 





 





 





 





 



 C<__MY__> can be changed by C attribute. 




2568




 





 





 





 





 





 



   




2569




 





 





 





 





 





 



 =item param 




2570




 





 





 





 





 





 



   




2571




 





 





 





 





 





 



   param => {'table2.key3' => 5} 




2572




 





 





 





 





 





 



   




2573




 





 





 





 





 





 



 Parameter shown before where clause. 




2574




 





 





 





 





 





 



    




2575




 





 





 





 





 





 



 For example, if you want to contain named placeholder in join clause,  




2576




 





 





 





 





 





 



 you can pass parameter by C option. 




2577




 





 





 





 





 





 



   




2578




 





 





 





 





 





 



   join  => ['inner join (select * from table2 where table2.key3 = :table2.key3)' .  




2579




 





 





 





 





 





 



             ' as table2 on table1.key1 = table2.key1'] 




2580




 





 





 





 





 





 



   




2581




 





 





 





 





 





 



 =item prefix 




2582




 





 





 





 





 





 



   




2583




 





 





 





 





 





 



   prefix => 'SQL_CALC_FOUND_ROWS' 




2584




 





 





 





 





 





 



   




2585




 





 





 





 





 





 



 Prefix of column clause 




2586




 





 





 





 





 





 



   




2587




 





 





 





 





 





 



   select SQL_CALC_FOUND_ROWS title, author from book; 




2588




 





 





 





 





 





 



   




2589




 





 





 





 





 





 



 =item join 




2590




 





 





 





 





 





 



   




2591




 





 





 





 





 





 



   join => [ 




2592




 





 





 





 





 





 



     'left outer join company on book.company_id = company_id', 




2593




 





 





 





 





 





 



     'left outer join location on company.location_id = location.id' 




2594




 





 





 





 





 





 



   ] 




2595




 





 





 





 





 





 



        




2596




 





 





 





 





 





 



 Join clause. If column clause or where clause contain table name like "company.name", 




2597




 





 





 





 





 





 



 join clauses needed when SQL is created is used automatically. 




2598




 





 





 





 





 





 



   




2599




 





 





 





 





 





 



   $dbi->select( 




2600




 





 





 





 





 





 



     table => 'book', 




2601




 





 





 





 





 





 



     column => ['company.location_id as location_id'], 




2602




 





 





 





 





 





 



     where => {'company.name' => 'Orange'}, 




2603




 





 





 





 





 





 



     join => [ 




2604




 





 





 





 





 





 



       'left outer join company on book.company_id = company.id', 




2605




 





 





 





 





 





 



       'left outer join location on company.location_id = location.id' 




2606




 





 





 





 





 





 



     ] 




2607




 





 





 





 





 





 



   ); 




2608




 





 





 





 





 





 



   




2609




 





 





 





 





 





 



 In above select, column and where clause contain "company" table, 




2610




 





 





 





 





 





 



 the following SQL is created 




2611




 





 





 





 





 





 



   




2612




 





 





 





 





 





 



   select company.location_id as location_id 




2613




 





 





 





 





 





 



   from book 




2614




 





 





 





 





 





 



     left outer join company on book.company_id = company.id 




2615




 





 





 





 





 





 



   where company.name = ?; 




2616




 





 





 





 





 





 



   




2617




 





 





 





 





 





 



 You can specify two table by yourself. This is useful when join parser can't parse 




2618




 





 





 





 





 





 



 the join clause correctly. 




2619




 





 





 





 





 





 



   




2620




 





 





 





 





 





 



   $dbi->select( 




2621




 





 





 





 





 





 



     table => 'book', 




2622




 





 





 





 





 





 



     column => ['company.location_id as location_id'], 




2623




 





 





 





 





 





 



     where => {'company.name' => 'Orange'}, 




2624




 





 





 





 





 





 



     join => [ 




2625




 





 





 





 





 





 



       { 




2626




 





 





 





 





 





 



         clause => 'left outer join location on company.location_id = location.id', 




2627




 





 





 





 





 





 



         table => ['company', 'location'] 




2628




 





 





 





 





 





 



       } 




2629




 





 





 





 





 





 



     ] 




2630




 





 





 





 





 





 



   ); 




2631




 





 





 





 





 





 



   




2632




 





 





 





 





 





 



 =item table 




2633




 





 





 





 





 





 



   




2634




 





 





 





 





 





 



   table => 'book' 




2635




 





 





 





 





 





 



   




2636




 





 





 





 





 





 



 Table name. 




2637




 





 





 





 





 





 



   




2638




 





 





 





 





 





 



 =item where 




2639




 





 





 





 





 





 



    




2640




 





 





 





 





 





 



   # (1) Hash reference 




2641




 





 





 





 





 





 



   where => {author => 'Ken', 'title' => ['Perl', 'Ruby']} 




2642




 





 





 





 





 





 



   # -> where author = 'Ken' and title in ('Perl', 'Ruby') 




2643




 





 





 





 





 





 



    




2644




 





 





 





 





 





 



   # (2) DBIx::Custom::Where object 




2645




 





 





 





 





 





 



   where => $dbi->where( 




2646




 





 





 





 





 





 



     clause => ['and', ':author{=}', ':title{like}'], 




2647




 





 





 





 





 





 



     param  => {author => 'Ken', title => '%Perl%'} 




2648




 





 





 





 





 





 



   ) 




2649




 





 





 





 





 





 



   # -> where author = 'Ken' and title like '%Perl%' 




2650




 





 





 





 





 





 



    




2651




 





 





 





 





 





 



   # (3) Array reference[where clause, parameters, join(optional)] 




2652




 





 





 





 





 





 



   where => [ 




2653




 





 





 





 





 





 



     ['and', ':author{=}', ':title{like}'], 




2654




 





 





 





 





 





 



     {author => 'Ken', title => '%Perl%'}, 




2655




 





 





 





 





 





 



     ["left outer join table2 on table1.key1 = table2.key1"] 




2656




 





 





 





 





 





 



   ] 




2657




 





 





 





 





 





 



   # -> where author = 'Ken' and title like '%Perl%' 




2658




 





 





 





 





 





 



    




2659




 





 





 





 





 





 



   # (4) Array reference[String, Hash reference] 




2660




 





 





 





 





 





 



   where => [ 




2661




 





 





 





 





 





 



     ':author{=} and :title{like}', 




2662




 





 





 





 





 





 



     {author => 'Ken', title => '%Perl%'} 




2663




 





 





 





 





 





 



   ] 




2664




 





 





 





 





 





 



   #  -> where author = 'Ken' and title like '%Perl%' 




2665




 





 





 





 





 





 



    




2666




 





 





 





 





 





 



   # (5) String 




2667




 





 





 





 





 





 



   where => 'title is null' 




2668




 





 





 





 





 





 



   #  -> where title is null 




2669




 





 





 





 





 





 



   




2670




 





 





 





 





 





 



 Where clause. 




2671




 





 





 





 





 





 



 See also L to know how to create where clause. 




2672




 





 





 





 





 





 



    




2673




 





 





 





 





 





 



 =back 




2674




 





 





 





 





 





 



   




2675




 





 





 





 





 





 



 =head2 type_rule 




2676




 





 





 





 





 





 



   




2677




 





 





 





 





 





 



   $dbi->type_rule( 




2678




 





 





 





 





 





 



     into1 => { 




2679




 





 





 





 





 





 



       date => sub { ... }, 




2680




 





 





 





 





 





 



       datetime => sub { ... } 




2681




 





 





 





 





 





 



     }, 




2682




 





 





 





 





 





 



     into2 => { 




2683




 





 





 





 





 





 



       date => sub { ... }, 




2684




 





 





 





 





 





 



       datetime => sub { ... } 




2685




 





 





 





 





 





 



     }, 




2686




 





 





 





 





 





 



     from1 => { 




2687




 





 





 





 





 





 



       # DATE 




2688




 





 





 





 





 





 



       9 => sub { ... }, 




2689




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2690




 





 





 





 





 





 



       11 => sub { ... }, 




2691




 





 





 





 





 





 



     } 




2692




 





 





 





 





 





 



     from2 => { 




2693




 





 





 





 





 





 



       # DATE 




2694




 





 





 





 





 





 



       9 => sub { ... }, 




2695




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2696




 





 





 





 





 





 



       11 => sub { ... }, 




2697




 





 





 





 





 





 



     } 




2698




 





 





 





 





 





 



   ); 




2699




 





 





 





 





 





 



   




2700




 





 





 





 





 





 



 Filtering rule when data is send into and get from database. 




2701




 





 





 





 





 





 



 This has a little complex problem. 




2702




 





 





 





 





 





 



   




2703




 





 





 





 





 





 



 In C and C you can specify 




2704




 





 





 





 





 





 



 type name as same as type name defined 




2705




 





 





 





 





 





 



 by create table, such as C or C. 




2706




 





 





 





 





 





 



   




2707




 





 





 





 





 





 



 Note that type name and data type don't contain upper case. 




2708




 





 





 





 





 





 



 If these contain upper case character, you convert it to lower case. 




2709




 





 





 





 





 





 



   




2710




 





 





 





 





 





 



 C is executed after C. 




2711




 





 





 





 





 





 



   




2712




 





 





 





 





 





 



 Type rule of C and C is enabled on the following 




2713




 





 





 





 





 





 



 column name. 




2714




 





 





 





 





 





 



   




2715




 





 





 





 





 





 



 =over 4 




2716




 





 





 





 





 





 



   




2717




 





 





 





 





 





 



 =item 1. column name 




2718




 





 





 





 





 





 



   




2719




 





 





 





 





 





 



   issue_date 




2720




 





 





 





 





 





 



   issue_datetime 




2721




 





 





 





 





 





 



   




2722




 





 





 





 





 





 



 This need C option in each method. 




2723




 





 





 





 





 





 



   




2724




 





 





 





 





 





 



 =item 2. table name and column name, separator is dot 




2725




 





 





 





 





 





 



   




2726




 





 





 





 





 





 



   book.issue_date 




2727




 





 





 





 





 





 



   book.issue_datetime 




2728




 





 





 





 





 





 



   




2729




 





 





 





 





 





 



 =back 




2730




 





 





 





 





 





 



   




2731




 





 





 





 





 





 



 You get all type name used in database by C. 




2732




 





 





 





 





 





 



   




2733




 





 





 





 





 





 



   print $dbi->available_typename; 




2734




 





 





 





 





 





 



   




2735




 





 





 





 





 





 



 In C and C you specify data type, not type name. 




2736




 





 





 





 





 





 



 C is executed after C. 




2737




 





 





 





 





 





 



 You get all data type by C. 




2738




 





 





 





 





 





 



   




2739




 





 





 





 





 





 



   print $dbi->available_datatype; 




2740




 





 





 





 





 





 



   




2741




 





 





 





 





 





 



 You can also specify multiple types at once. 




2742




 





 





 





 





 





 



   




2743




 





 





 





 





 





 



   $dbi->type_rule( 




2744




 





 





 





 





 





 



     into1 => [ 




2745




 





 





 





 





 





 



       [qw/DATE DATETIME/] => sub { ... }, 




2746




 





 





 





 





 





 



     ], 




2747




 





 





 





 





 





 



   ); 




2748




 





 





 





 





 





 



   




2749




 





 





 





 





 





 



 =head2 update 




2750




 





 





 





 





 





 



   




2751




 





 





 





 





 





 



   $dbi->update({title => 'Perl'}, table  => 'book', where  => {id => 4}); 




2752




 





 





 





 





 





 



   




2753




 





 





 





 





 





 



 Execute update statement. First argument is update row data. 




2754




 





 





 





 





 





 



   




2755




 





 





 





 





 





 



 If you want to set constant value to row data, use scalar reference 




2756




 





 





 





 





 





 



 as parameter value. 




2757




 





 





 





 





 





 



   




2758




 





 





 





 





 





 



   {date => \"NOW()"} 




2759




 





 





 





 





 





 



   




2760




 





 





 





 





 





 



 B 




2761




 





 





 





 





 





 



   




2762




 





 





 





 





 





 



 C method use all of C method's options, 




2763




 





 





 





 





 





 



 and use the following new ones. 




2764




 





 





 





 





 





 



   




2765




 





 





 





 





 





 



 =over 4 




2766




 





 





 





 





 





 



   




2767




 





 





 





 





 





 



 =item prefix 




2768




 





 





 





 





 





 



   




2769




 





 





 





 





 





 



   prefix => 'or replace' 




2770




 





 





 





 





 





 



   




2771




 





 





 





 





 





 



 prefix before table name section 




2772




 





 





 





 





 





 



   




2773




 





 





 





 





 





 



   update or replace book 




2774




 





 





 





 





 





 



   




2775




 





 





 





 





 





 



 =item table 




2776




 





 





 





 





 





 



   




2777




 





 





 





 





 





 



   table => 'book' 




2778




 





 





 





 





 





 



   




2779




 





 





 





 





 





 



 Table name. 




2780




 





 





 





 





 





 



   




2781




 





 





 





 





 





 



 =item where 




2782




 





 





 





 





 





 



   




2783




 





 





 





 





 





 



 Same as C method's C option. 




2784




 





 





 





 





 





 



   




2785




 





 





 





 





 





 



 =item wrap 




2786




 





 





 





 





 





 



   




2787




 





 





 





 





 





 



   wrap => {price => sub { "max($_[0])" }} 




2788




 





 





 





 





 





 



   




2789




 





 





 





 





 





 



 placeholder wrapped string. 




2790




 





 





 





 





 





 



   




2791




 





 





 





 





 





 



 If the following statement 




2792




 





 





 





 





 





 



   




2793




 





 





 





 





 





 



   $dbi->update({price => 100}, table => 'book', 




2794




 





 





 





 





 





 



     {price => sub { "$_[0] + 5" }}); 




2795




 





 





 





 





 





 



   




2796




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2797




 





 





 





 





 





 



   




2798




 





 





 





 





 





 



   update book set price =  ? + 5; 




2799




 





 





 





 





 





 



   




2800




 





 





 





 





 





 



 =item mtime 




2801




 





 





 





 





 





 



   




2802




 





 





 





 





 





 



   mtime => 'modified_time' 




2803




 





 





 





 





 





 



   




2804




 





 





 





 





 





 



 Modified time column name. time row is updated is set to the column. 




2805




 





 





 





 





 





 



 default time format is C, which can be changed by 




2806




 





 





 





 





 





 



 C attribute. 




2807




 





 





 





 





 





 



   




2808




 





 





 





 





 





 



 =back 




2809




 





 





 





 





 





 



   




2810




 





 





 





 





 





 



 =head2 update_all 




2811




 





 





 





 





 





 



   




2812




 





 





 





 





 





 



   $dbi->update_all({title => 'Perl'}, table => 'book', ); 




2813




 





 





 





 





 





 



   




2814




 





 





 





 





 





 



 Execute update statement for all rows. 




2815




 





 





 





 





 





 



 Options is same as C method. 




2816




 





 





 





 





 





 



   




2817




 





 





 





 





 





 



 =over 4 




2818




 





 





 





 





 





 



   




2819




 





 





 





 





 





 



 =item option 




2820




 





 





 





 





 





 



   




2821




 





 





 





 





 





 



   option => { 




2822




 





 





 





 





 





 



     select => { 




2823




 





 





 





 





 





 



       append => '...' 




2824




 





 





 





 





 





 



     }, 




2825




 





 





 





 





 





 



     insert => { 




2826




 





 





 





 





 





 



       prefix => '...' 




2827




 





 





 





 





 





 



     }, 




2828




 





 





 





 





 





 



     update => { 




2829




 





 





 





 





 





 



       filter => {} 




2830




 





 





 





 





 





 



     } 




2831




 





 





 





 





 





 



   } 




2832




 





 





 





 





 





 



   




2833




 





 





 





 





 





 



 If you want to pass option to each method, 




2834




 





 





 





 





 





 



 you can use C option. 




2835




 





 





 





 





 





 



   




2836




 





 





 





 





 





 



 =over 4 




2837




 





 





 





 





 





 



   




2838




 





 





 





 





 





 



 =item select_option 




2839




 





 





 





 





 





 



   




2840




 





 





 





 





 





 



   select_option => {append => 'for update'} 




2841




 





 





 





 





 





 



   




2842




 





 





 





 





 





 



 select method option, 




2843




 





 





 





 





 





 



 select method is used to check the row is already exists. 




2844




 





 





 





 





 





 



   




2845




 





 





 





 





 





 



 =head2 show_datatype 




2846




 





 





 





 





 





 



   




2847




 





 





 





 





 





 



   $dbi->show_datatype($table); 




2848




 





 





 





 





 





 



   




2849




 





 





 





 





 





 



 Show data type of the columns of specified table. 




2850




 





 





 





 





 





 



   




2851




 





 





 





 





 





 



   book 




2852




 





 





 





 





 





 



   title: 5 




2853




 





 





 





 





 





 



   issue_date: 91 




2854




 





 





 





 





 





 



   




2855




 





 





 





 





 





 



 This data type is used in C's C and C. 




2856




 





 





 





 





 





 



   




2857




 





 





 





 





 





 



 =head2 show_tables 




2858




 





 





 





 





 





 



   




2859




 





 





 





 





 





 



   $dbi->show_tables; 




2860




 





 





 





 





 





 



   




2861




 





 





 





 





 





 



 Show tables. 




2862




 





 





 





 





 





 



   




2863




 





 





 





 





 





 



 =head2 show_typename 




2864




 





 





 





 





 





 



   




2865




 





 





 





 





 





 



   $dbi->show_typename($table); 




2866




 





 





 





 





 





 



   




2867




 





 





 





 





 





 



 Show type name of the columns of specified table. 




2868




 





 





 





 





 





 



   




2869




 





 





 





 





 





 



   book 




2870




 





 





 





 





 





 



   title: varchar 




2871




 





 





 





 





 





 



   issue_date: date 




2872




 





 





 





 





 





 



   




2873




 





 





 





 





 





 



 This type name is used in C's C and C. 




2874




 





 





 





 





 





 



   




2875




 





 





 





 





 





 



 =head2 values_clause 




2876




 





 





 





 





 





 



   




2877




 





 





 





 





 





 



   my $values_clause = $dbi->values_clause({title => 'a', age => 2}); 




2878




 





 





 





 





 





 



   




2879




 





 





 





 





 





 



 Create values clause. 




2880




 





 





 





 





 





 



   




2881




 





 





 





 





 





 



   (title, author) values (title = :title, age = :age); 




2882




 





 





 





 





 





 



   




2883




 





 





 





 





 





 



 You can use this in insert statement. 




2884




 





 





 





 





 





 



   




2885




 





 





 





 





 





 



   my $insert_sql = "insert into book $values_clause"; 




2886




 





 





 





 





 





 



   




2887




 





 





 





 





 





 



 =head2 where 




2888




 





 





 





 





 





 



   




2889




 





 





 





 





 





 



   my $where = $dbi->where; 




2890




 





 





 





 





 





 



   $where->clause(['and', 'title = :title', 'author = :author']); 




2891




 





 





 





 





 





 



   $where->param({title => 'Perl', author => 'Ken'}); 




2892




 





 





 





 





 





 



   $where->join(['left join author on book.author = author.id]); 




2893




 





 





 





 





 





 



   




2894




 





 





 





 





 





 



 Create a new L object. 




2895




 





 





 





 





 





 



 See L to know how to create where clause. 




2896




 





 





 





 





 





 



   




2897




 





 





 





 





 





 



 =head1 ENVIRONMENTAL VARIABLES 




2898




 





 





 





 





 





 



   




2899




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG 




2900




 





 





 





 





 





 



   




2901




 





 





 





 





 





 



 If environment variable C is set to true, 




2902




 





 





 





 





 





 



 executed SQL and bind values are printed to STDERR. 




2903




 





 





 





 





 





 



   




2904




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG_ENCODING 




2905




 





 





 





 





 





 



   




2906




 





 





 





 





 





 



 DEBUG output encoding. Default to UTF-8. 




2907




 





 





 





 





 





 



   




2908




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION 




2909




 





 





 





 





 





 



   




2910




 





 





 





 





 





 



   $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25'; 




2911




 





 





 





 





 





 



   




2912




 





 





 





 





 





 



 Suppress deprecation warnings before specified version. 




2913




 





 





 





 





 





 



   




2914




 





 





 





 





 





 



 =head1 DEPRECATED FUNCTIONALITY 




2915




 





 





 





 





 





 



   




2916




 





 





 





 





 





 



 L 




2917




 





 





 





 





 





 



   




2918




 





 





 





 





 





 



   # Methods 




2919




 





 





 





 





 





 



   DBIx::Custom AUTOLOAD feature # will be removed at 2022/5/1 




2920




 





 





 





 





 





 



   DBIx::Custom::helper method # will be removed at 2022/5/1 




2921




 





 





 





 





 





 



   DBIx::Custom::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1 




2922




 





 





 





 





 





 



   DBIx::Custom::count method # will be removed at 2022/5/1 




2923




 





 





 





 





 





 



   DBIx::Custom::select,update,delete method's primary_key option is DEPRECATED! # will be removed at 2022/5/1 




2924




 





 





 





 





 





 



   DBIx::Custom::select,update,delete method's id option is DEPRECATED! # will be removed at 2022/5/1 




2925




 





 





 





 





 





 



   DBIx::Custom::setup method is DEPRECATED! # will be removed at 2022/5/1 




2926




 





 





 





 





 





 



   




2927




 





 





 





 





 





 



 L 




2928




 





 





 





 





 





 



    




2929




 





 





 





 





 





 



   # Options 




2930




 





 





 





 





 





 



   kv method's multi option (from 0.28) # will be removed at 2018/3/1 




2931




 





 





 





 





 





 



   




2932




 





 





 





 





 





 



 L 




2933




 





 





 





 





 





 



   




2934




 





 





 





 





 





 



   DBIx::Custom::Model AUTOLOAD feature # will be removed at 2022/5/1 




2935




 





 





 





 





 





 



   DBIx::Custom::Model::helper method is DEPRECATED! # will be removed at 2022/5/1 




2936




 





 





 





 





 





 



   DBIx::Custom::Model::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1 




2937




 





 





 





 





 





 



   DBIx::Custom::Model::count method # will be removed at 2022/5/1 




2938




 





 





 





 





 





 



   DBIx::Custom::Model::primary_key attribute is DEPRECATED! # will be removed at 2022/5/1 




2939




 





 





 





 





 





 



   




2940




 





 





 





 





 





 



 =head1 BACKWARDS COMPATIBILITY POLICY 




2941




 





 





 





 





 





 



   




2942




 





 





 





 





 





 



 If a feature is DEPRECATED, you can know it by DEPRECATED warnings. 




2943




 





 





 





 





 





 



 DEPRECATED feature is removed after C, 




2944




 





 





 





 





 





 



 but if at least one person use the feature and tell me that thing 




2945




 





 





 





 





 





 



 I extend one year each time he tell me it. 




2946




 





 





 





 





 





 



   




2947




 





 





 





 





 





 



 DEPRECATION warnings can be suppressed by C 




2948




 





 





 





 





 





 



 environment variable. 




2949




 





 





 





 





 





 



   




2950




 





 





 





 





 





 



 EXPERIMENTAL features will be changed or deleted without warnings. 




2951




 





 





 





 





 





 



   




2952




 





 





 





 





 





 



 =head1 BUGS 




2953




 





 





 





 





 





 



   




2954




 





 





 





 





 





 



 Please tell me bugs if you find bug. 




2955




 





 





 





 





 





 



   




2956




 





 





 





 





 





 



 C<<  >> 




2957




 





 





 





 





 





 



   




2958




 





 





 





 





 





 



 L 




2959




 





 





 





 





 





 



   




2960




 





 





 





 





 





 



 =head1 AUTHOR 




2961




 





 





 





 





 





 



   




2962




 





 





 





 





 





 



 Yuki Kimoto, C<<  >> 




2963




 





 





 





 





 





 



   




2964




 





 





 





 





 





 



 =head1 COPYRIGHT & LICENSE 




2965




 





 





 





 





 





 



   




2966




 





 





 





 





 





 



 Copyright 2009-2019 Yuki Kimoto, all rights reserved. 




2967




 





 





 





 





 





 



   




2968




 





 





 





 





 





 



 This program is free software; you can redistribute it and/or modify it 




2969




 





 





 





 





 





 



 under the same terms as Perl itself. 




2970




 





 





 





 





 





 



   




2971




 





 





 





 





 





 



 =cut

If C is set, C method use C
information, you can improve the performance of C in
the following way.

  my $table_infos = $dbi->get_table_info(exclude => qr/^system_/);
  $dbi->user_table_info($table_info);
  $dbi->each_table(sub { ... });

=head2 execute

  my $result = $dbi->execute(
    "select * from book where title = :title and author like :author",
    {title => 'Perl', author => '%Ken%'}
  );

  my $result = $dbi->execute(
    "select * from book where title = :book.title and author like :book.author",
    {'book.title' => 'Perl', 'book.author' => '%Ken%'}
  );

Execute SQL. SQL can contain column parameter such as :author and :title.
You can append table name to column name such as :book.title and :book.author.
Second argument is data, embedded into column parameter.
Return value is L object when select statement is executed,
or the count of affected rows when insert, update, delete statement is executed.

Named placeholder such as C<:title> is replaced by placeholder C.

  # Original
  select * from book where title = :title and author like :author

  # Replaced
  select * from where title = ? and author like ?;

You can specify operator with named placeholder
by C syntax.

  # Original
  select * from book where :title{=} and :author{like}

  # Replaced
  select * from where title = ? and author like ?;

Note that colons in time format such as 12:13:15 is an exception,
it is not parsed as named placeholder.
If you want to use colon generally, you must escape it by C<\\>

  select * from where title = "aa\\:bb";

B

The following options are available.

=over 4

=item after_build_sql

You can filter sql after the sql is build.

  after_build_sql => $code_ref

The following one is one example.

  $dbi->select(
    table => 'book',
    column => 'distinct(name)',
    after_build_sql => sub {
      "select count(*) from ($_[0]) as t1"
    }
  );

The following SQL is executed.

  select count(*) from (select distinct(name) from book) as t1;

=item append

  append => 'order by name'

Append some statement after SQL.

=item bind_type

Specify database bind data type.

  bind_type => {image => DBI::SQL_BLOB}
  bind_type => [image => DBI::SQL_BLOB]
  bind_type => [[qw/image audio/] => DBI::SQL_BLOB]

This is used to bind parameter by C of statement handle.

  $sth->bind_param($pos, $value, DBI::SQL_BLOB);

=item filter

  filter => {
    title  => sub { uc $_[0] }
    author => sub { uc $_[0] }
  }

  # Filter name
  filter => {
    title  => 'upper_case',
    author => 'upper_case'
  }

  # At once
  filter => [
    [qw/title author/]  => sub { uc $_[0] }
  ]

Filter. You can set subroutine or filter name
registered by C.
This filter is executed before data is saved into database.
and before type rule filter is executed.

=item reuse

  reuse => $hash_ref

Reuse statement handle in same SQL.

  my $reuse = {};
  $dbi->execute($sql, $param, reuse => $reuse);

This will improved performance when you want to execute same sql repeatedly.

=item table

  table => 'author'

If you want to omit table name in column name
and enable C and C type filter,
You must set C option. 




2217




 





 





 





 





 





 



   




2218




 





 





 





 





 





 



   $dbi->execute("select * from book where title = :title and author = :author", 




2219




 





 





 





 





 





 



     {title => 'Perl', author => 'Ken', table => 'book'); 




2220




 





 





 





 





 





 



   




2221




 





 





 





 





 





 



   # Same 




2222




 





 





 





 





 





 



   $dbi->execute( 




2223




 





 





 





 





 





 



     "select * from book where title = :book.title and author = :book.author", 




2224




 





 





 





 





 





 



     {title => 'Perl', author => 'Ken'); 




2225




 





 





 





 





 





 



   




2226




 





 





 





 





 





 



 =item table_alias 




2227




 





 





 





 





 





 



   




2228




 





 





 





 





 





 



   table_alias => {worker => 'user'} # {ALIAS => TABLE} 




2229




 





 





 





 





 





 



   




2230




 





 





 





 





 





 



 Table alias. Key is alias table name, value is real table name, . 




2231




 





 





 





 





 





 



 If you set C, you can enable C and C type rule 




2232




 





 





 





 





 





 



 on alias table name. 




2233




 





 





 





 





 





 



   




2234




 





 





 





 





 





 



 =item type_rule_off 




2235




 





 





 





 





 





 



   




2236




 





 





 





 





 





 



   type_rule_off => 1 




2237




 





 





 





 





 





 



   




2238




 





 





 





 





 





 



 Turn C and C type rule off. 




2239




 





 





 





 





 





 



   




2240




 





 





 





 





 





 



 =item type_rule1_off 




2241




 





 





 





 





 





 



   




2242




 





 





 





 





 





 



   type_rule1_off => 1 




2243




 





 





 





 





 





 



   




2244




 





 





 





 





 





 



 Turn C type rule off. 




2245




 





 





 





 





 





 



   




2246




 





 





 





 





 





 



 =item type_rule2_off 




2247




 





 





 





 





 





 



   




2248




 





 





 





 





 





 



   type_rule2_off => 1 




2249




 





 





 





 





 





 



   




2250




 





 





 





 





 





 



 Turn C type rule off. 




2251




 





 





 





 





 





 



   




2252




 





 





 





 





 





 



 =item prepare_attr 




2253




 





 





 





 





 





 



   




2254




 





 





 





 





 





 



   prepare_attr => {mysql_use_result => 1} 




2255




 





 





 





 





 





 



   




2256




 





 





 





 





 





 



 Statemend handle attributes, 




2257




 





 





 





 





 





 



 this is L's C method second argument. 




2258




 





 





 





 





 





 



   




2259




 





 





 





 





 





 



 =head2 get_column_info 




2260




 





 





 





 





 





 



   




2261




 





 





 





 





 





 



   my $column_infos = $dbi->get_column_info(exclude_table => qr/^system_/); 




2262




 





 





 





 





 





 



   




2263




 





 





 





 





 





 



 get column information except for one which match C pattern. 




2264




 





 





 





 





 





 



   




2265




 





 





 





 





 





 



   [ 




2266




 





 





 





 





 





 



     {table => 'book', column => 'title', info => {...}}, 




2267




 





 





 





 





 





 



     {table => 'author', column => 'name' info => {...}} 




2268




 





 





 





 





 





 



   ] 




2269




 





 





 





 





 





 



   




2270




 





 





 





 





 





 



 =head2 get_table_info 




2271




 





 





 





 





 





 



   




2272




 





 





 





 





 





 



   my $table_infos = $dbi->get_table_info(exclude => qr/^system_/); 




2273




 





 





 





 





 





 



   




2274




 





 





 





 





 





 



 get table information except for one which match C pattern. 




2275




 





 





 





 





 





 



   




2276




 





 





 





 





 





 



   [ 




2277




 





 





 





 





 





 



     {table => 'book', info => {...}}, 




2278




 





 





 





 





 





 



     {table => 'author', info => {...}} 




2279




 





 





 





 





 





 



   ] 




2280




 





 





 





 





 





 



   




2281




 





 





 





 





 





 



 You can set this value to C. 




2282




 





 





 





 





 





 



   




2283




 





 





 





 





 





 



 =head2 insert 




2284




 





 





 





 





 





 



   




2285




 





 





 





 





 





 



   $dbi->insert({title => 'Perl', author => 'Ken'}, table  => 'book'); 




2286




 





 





 





 





 





 



   




2287




 





 





 





 





 





 



 Execute insert statement. First argument is row data. Return value is 




2288




 





 





 





 





 





 



 affected row count. 




2289




 





 





 





 





 





 



   




2290




 





 





 





 





 





 



 If you want to set constant value to row data, use scalar reference 




2291




 





 





 





 





 





 



 as parameter value. 




2292




 





 





 





 





 





 



   




2293




 





 





 





 





 





 



   {date => \"NOW()"} 




2294




 





 





 





 





 





 



   




2295




 





 





 





 





 





 



 You can pass multiple parameters, this is very fast. 




2296




 





 





 





 





 





 



   




2297




 





 





 





 





 





 



   $dbi->insert( 




2298




 





 





 





 





 





 



     [ 




2299




 





 





 





 





 





 



       {title => 'Perl', author => 'Ken'}, 




2300




 





 





 





 





 





 



       {title => 'Ruby', author => 'Tom'} 




2301




 





 





 





 





 





 



     ], 




2302




 





 





 





 





 





 



     table  => 'book' 




2303




 





 





 





 





 





 



   ); 




2304




 





 





 





 





 





 



   




2305




 





 





 





 





 





 



 In multiple insert, you can't use C option. 




2306




 





 





 





 





 





 



 and only first parameter is used to create sql. 




2307




 





 





 





 





 





 



   




2308




 





 





 





 





 





 



 B 




2309




 





 





 





 





 





 



   




2310




 





 





 





 





 





 



 C method use all of C method's options, 




2311




 





 





 





 





 





 



 and use the following new ones. 




2312




 





 





 





 





 





 



   




2313




 





 





 





 





 





 



 =over 4 




2314




 





 





 





 





 





 



   




2315




 





 





 





 





 





 



 =item bulk_insert 




2316




 





 





 





 





 





 



   




2317




 





 





 





 





 





 



   bulk_insert => 1 




2318




 





 





 





 





 





 



   




2319




 





 





 





 





 





 



 bulk insert is executed if database support bulk insert and  




2320




 





 





 





 





 





 



 multiple parameters is passed to C. 




2321




 





 





 





 





 





 



 The SQL like the following one is executed. 




2322




 





 





 





 





 





 



   




2323




 





 





 





 





 





 



   insert into book (id, title) values (?, ?), (?, ?); 




2324




 





 





 





 





 





 



   




2325




 





 





 





 





 





 



 =item ctime 




2326




 





 





 





 





 





 



   




2327




 





 





 





 





 





 



   ctime => 'created_time' 




2328




 





 





 





 





 





 



   




2329




 





 





 





 





 





 



 Created time column name. time when row is created is set to the column. 




2330




 





 





 





 





 





 



 default time format is "YYYY-mm-dd HH:MM:SS", which can be changed by 




2331




 





 





 





 





 





 



 C attribute. 




2332




 





 





 





 





 





 



   




2333




 





 





 





 





 





 



 =item prefix 




2334




 





 





 





 





 





 



   




2335




 





 





 





 





 





 



   prefix => 'or replace' 




2336




 





 





 





 





 





 



   




2337




 





 





 





 





 





 



 prefix before table name section 




2338




 





 





 





 





 





 



   




2339




 





 





 





 





 





 



   insert or replace into book 




2340




 





 





 





 





 





 



   




2341




 





 





 





 





 





 



 =item table 




2342




 





 





 





 





 





 



   




2343




 





 





 





 





 





 



   table => 'book' 




2344




 





 





 





 





 





 



   




2345




 





 





 





 





 





 



 Table name. 




2346




 





 





 





 





 





 



   




2347




 





 





 





 





 





 



 =item mtime 




2348




 





 





 





 





 





 



   




2349




 





 





 





 





 





 



 This option is same as C method C option. 




2350




 





 





 





 





 





 



   




2351




 





 





 





 





 





 



 =item wrap 




2352




 





 





 





 





 





 



   




2353




 





 





 





 





 





 



   wrap => {price => sub { "max($_[0])" }} 




2354




 





 





 





 





 





 



   




2355




 





 





 





 





 





 



 placeholder wrapped string. 




2356




 





 





 





 





 





 



   




2357




 





 





 





 





 





 



 If the following statement 




2358




 





 





 





 





 





 



   




2359




 





 





 





 





 





 



   $dbi->insert({price => 100}, table => 'book', 




2360




 





 





 





 





 





 



     {price => sub { "$_[0] + 5" }}); 




2361




 





 





 





 





 





 



   




2362




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2363




 





 





 





 





 





 



   




2364




 





 





 





 





 





 



   insert into book price values ( ? + 5 ); 




2365




 





 





 





 





 





 



   




2366




 





 





 





 





 





 



 =back 




2367




 





 





 





 





 





 



   




2368




 





 





 





 





 





 



 =over 4 




2369




 





 





 





 





 





 



   




2370




 





 





 





 





 





 



 =head2 include_model 




2371




 





 





 





 





 





 



   




2372




 





 





 





 





 





 



   $dbi->include_model('MyModel'); 




2373




 





 





 





 





 





 



   




2374




 





 





 





 





 





 



 Include models from specified namespace, 




2375




 





 





 





 





 





 



 the following layout is needed to include models. 




2376




 





 





 





 





 





 



   




2377




 





 





 





 





 





 



   lib / MyModel.pm 




2378




 





 





 





 





 





 



       / MyModel / book.pm 




2379




 





 





 





 





 





 



                 / company.pm 




2380




 





 





 





 





 





 



   




2381




 





 





 





 





 





 



 Name space module, extending L. 




2382




 





 





 





 





 





 



   




2383




 





 





 





 





 





 



 B 




2384




 





 





 





 





 





 



   




2385




 





 





 





 





 





 



   package MyModel; 




2386




 





 





 





 





 





 



   use DBIx::Custom::Model -base; 




2387




 





 





 





 





 





 



    




2388




 





 





 





 





 





 



   1; 




2389




 





 





 





 





 





 



   




2390




 





 





 





 





 





 



 Model modules, extending name space module. 




2391




 





 





 





 





 





 



   




2392




 





 





 





 





 





 



 B 




2393




 





 





 





 





 





 



   




2394




 





 





 





 





 





 



   package MyModel::book; 




2395




 





 





 





 





 





 



   use MyModel -base; 




2396




 





 





 





 





 





 



    




2397




 





 





 





 





 





 



   1; 




2398




 





 





 





 





 





 



   




2399




 





 





 





 





 





 



 B 




2400




 





 





 





 





 





 



   




2401




 





 





 





 





 





 



   package MyModel::company; 




2402




 





 





 





 





 





 



   use MyModel -base; 




2403




 





 





 





 





 





 



    




2404




 





 





 





 





 





 



   1; 




2405




 





 





 





 





 





 



    




2406




 





 





 





 





 





 



 MyModel::book and MyModel::company is included by C. 




2407




 





 





 





 





 





 



   




2408




 





 





 





 





 





 



 You can get model object by C. 




2409




 





 





 





 





 





 



   




2410




 





 





 





 





 





 



   my $book_model = $dbi->model('book'); 




2411




 





 





 





 





 





 



   my $company_model = $dbi->model('company'); 




2412




 





 





 





 





 





 



   




2413




 





 





 





 





 





 



 You can include full-qualified table name like C 




2414




 





 





 





 





 





 



   




2415




 





 





 





 





 





 



   lib / MyModel.pm 




2416




 





 





 





 





 





 



       / MyModel / main / book.pm 




2417




 





 





 





 





 





 



                        / company.pm 




2418




 





 





 





 





 





 



   




2419




 





 





 





 





 





 



   my $main_book = $self->model('main.book'); 




2420




 





 





 





 





 





 



   




2421




 





 





 





 





 





 



 See L to know model features. 




2422




 





 





 





 





 





 



   




2423




 





 





 





 





 





 



 =head2 like_value 




2424




 





 





 





 





 





 



   




2425




 





 





 





 





 





 



   my $like_value = $dbi->like_value 




2426




 





 





 





 





 





 



   




2427




 





 





 





 





 





 



 Code reference which return a value for the like value. 




2428




 





 





 





 





 





 



   




2429




 





 





 





 





 





 



   sub { "%$_[0]%" } 




2430




 





 





 





 





 





 



   




2431




 





 





 





 





 





 



 =head2 mapper 




2432




 





 





 





 





 





 



   




2433




 





 





 





 





 





 



   my $mapper = $dbi->mapper(param => $param); 




2434




 





 





 





 





 





 



   




2435




 





 





 





 





 





 



 Create a new L object. 




2436




 





 





 





 





 





 



   




2437




 





 





 





 





 





 



 =head2 merge_param 




2438




 





 





 





 





 





 



   




2439




 





 





 





 





 





 



   my $param = $dbi->merge_param({key1 => 1}, {key1 => 1, key2 => 2}); 




2440




 





 





 





 





 





 



   




2441




 





 





 





 





 





 



 Merge parameters. The following new parameter is created. 




2442




 





 





 





 





 





 



   




2443




 





 





 





 





 





 



   {key1 => [1, 1], key2 => 2} 




2444




 





 





 





 





 





 



   




2445




 





 





 





 





 





 



 If same keys contains, the value is converted to array reference. 




2446




 





 





 





 





 





 



   




2447




 





 





 





 





 





 



 =head2 model 




2448




 





 





 





 





 





 



   




2449




 





 





 





 





 





 



   my $model = $dbi->model('book'); 




2450




 





 





 





 





 





 



   




2451




 





 





 





 





 





 



 Get a L object 




2452




 





 





 





 





 





 



 create by C or C 




2453




 





 





 





 





 





 



   




2454




 





 





 





 





 





 



 =head2 mycolumn 




2455




 





 





 





 





 





 



   




2456




 





 





 





 





 





 



   my $column = $dbi->mycolumn(book => ['author', 'title']); 




2457




 





 





 





 





 





 



   




2458




 





 





 





 





 





 



 Create column clause for myself. The following column clause is created. 




2459




 





 





 





 





 





 



   




2460




 





 





 





 





 





 



   book.author as author, 




2461




 





 





 





 





 





 



   book.title as title 




2462




 





 





 





 





 





 



   




2463




 





 





 





 





 





 



 =head2 new 




2464




 





 





 





 





 





 



   




2465




 





 





 





 





 





 



   my $dbi = DBIx::Custom->new( 




2466




 





 





 





 





 





 



     dsn => "dbi:mysql:database=dbname", 




2467




 





 





 





 





 





 



     user => 'ken', 




2468




 





 





 





 





 





 



     password => '!LFKD%$&', 




2469




 





 





 





 





 





 



     option => {mysql_enable_utf8 => 1} 




2470




 





 





 





 





 





 



   ); 




2471




 





 





 





 





 





 



   




2472




 





 





 





 





 





 



 Create a new L object. 




2473




 





 





 





 





 





 



   




2474




 





 





 





 





 





 



 =head2 not_exists 




2475




 





 





 





 





 





 



   




2476




 





 





 





 





 





 



   my $not_exists = $dbi->not_exists; 




2477




 





 





 





 





 





 



   




2478




 





 





 





 





 





 



 DBIx::Custom::NotExists object, indicating the column is not exists. 




2479




 





 





 





 





 





 



 This is used in C of L . 




2480




 





 





 





 





 





 



   




2481




 





 





 





 





 





 



 =head2 order 




2482




 





 





 





 





 





 



   




2483




 





 





 





 





 





 



   my $order = $dbi->order; 




2484




 





 





 





 





 





 



   




2485




 





 





 





 





 





 



 Create a new L object. 




2486




 





 





 





 





 





 



   




2487




 





 





 





 





 





 



 =head2 q 




2488




 





 





 





 





 





 



   




2489




 





 





 





 





 





 



   my $quooted = $dbi->q("title"); 




2490




 





 





 





 





 





 



   




2491




 





 





 





 





 





 



 Quote string by value of C. 




2492




 





 





 





 





 





 



   




2493




 





 





 





 





 





 



 =head2 register_filter 




2494




 





 





 





 





 





 



   




2495




 





 





 





 





 





 



   $dbi->register_filter( 




2496




 





 





 





 





 





 



     # Time::Piece object to database DATE format 




2497




 





 





 





 





 





 



     tp_to_date => sub { 




2498




 





 





 





 





 





 



       my $tp = shift; 




2499




 





 





 





 





 





 



       return $tp->strftime('%Y-%m-%d'); 




2500




 





 





 





 





 





 



     }, 




2501




 





 





 





 





 





 



     # database DATE format to Time::Piece object 




2502




 





 





 





 





 





 



     date_to_tp => sub { 




2503




 





 





 





 





 





 



       my $date = shift; 




2504




 





 





 





 





 





 



       return Time::Piece->strptime($date, '%Y-%m-%d'); 




2505




 





 





 





 





 





 



     } 




2506




 





 





 





 





 





 



   ); 




2507




 





 





 





 





 





 



    




2508




 





 





 





 





 





 



 Register filters, used by C option of many methods. 




2509




 





 





 





 





 





 



   




2510




 





 





 





 





 





 



 =head2 select 




2511




 





 





 





 





 





 



   




2512




 





 





 





 





 





 



   my $result = $dbi->select( 




2513




 





 





 





 





 





 



     column => ['author', 'title'], 




2514




 





 





 





 





 





 



     table  => 'book', 




2515




 





 





 





 





 





 



     where  => {author => 'Ken'}, 




2516




 





 





 





 





 





 



   ); 




2517




 





 





 





 





 





 



    




2518




 





 





 





 





 





 



 Execute select statement. 




2519




 





 





 





 





 





 



   




2520




 





 





 





 





 





 



 You can pass odd number arguments. first argument is C. 




2521




 





 





 





 





 





 



   




2522




 





 





 





 





 





 



   my $result = $dbi->select(['author', 'title'], table => 'book'); 




2523




 





 





 





 





 





 



   




2524




 





 





 





 





 





 



 B 




2525




 





 





 





 





 





 



   




2526




 





 





 





 





 





 



 C method use all of C method's options, 




2527




 





 





 





 





 





 



 and use the following new ones. 




2528




 





 





 





 





 





 



   




2529




 





 





 





 





 





 



 =over 4 




2530




 





 





 





 





 





 



   




2531




 





 





 





 





 





 



 =item column 




2532




 





 





 





 





 





 



    




2533




 





 





 





 





 





 



   column => 'author' 




2534




 





 





 





 





 





 



   column => ['author', 'title'] 




2535




 





 





 





 





 





 



   




2536




 





 





 





 





 





 



 Column clause. 




2537




 





 





 





 





 





 



    




2538




 





 





 





 





 





 



 if C is not specified, '*' is set. 




2539




 





 





 





 





 





 



   




2540




 





 





 





 





 





 



   column => '*' 




2541




 





 





 





 





 





 



   




2542




 





 





 





 





 





 



 You can specify hash of array reference. 




2543




 





 





 





 





 





 



   




2544




 





 





 





 





 





 



   column => [ 




2545




 





 





 





 





 





 



     {book => [qw/author title/]}, 




2546




 





 





 





 





 





 



     {person => [qw/name age/]} 




2547




 





 





 





 





 





 



   ] 




2548




 





 





 





 





 





 



   




2549




 





 





 





 





 





 



 This is expanded to the following one by using C method. 




2550




 





 





 





 





 





 



   




2551




 





 





 





 





 





 



   book.author as "book.author", 




2552




 





 





 





 





 





 



   book.title as "book.title", 




2553




 





 





 





 





 





 



   person.name as "person.name", 




2554




 





 





 





 





 





 



   person.age as "person.age" 




2555




 





 





 





 





 





 



   




2556




 





 





 





 





 





 



 You can specify own column by C<__MY__>. 




2557




 





 





 





 





 





 



   




2558




 





 





 





 





 





 



   column => [ 




2559




 





 





 





 





 





 



     {__MY__ => [qw/author title/]}, 




2560




 





 





 





 





 





 



   ] 




2561




 





 





 





 





 





 



   




2562




 





 





 





 





 





 



 This is expanded to the following one by using C method. 




2563




 





 





 





 





 





 



   




2564




 





 





 





 





 





 



   book.author as "author", 




2565




 





 





 





 





 





 



   book.title as "title", 




2566




 





 





 





 





 





 



   




2567




 





 





 





 





 





 



 C<__MY__> can be changed by C attribute. 




2568




 





 





 





 





 





 



   




2569




 





 





 





 





 





 



 =item param 




2570




 





 





 





 





 





 



   




2571




 





 





 





 





 





 



   param => {'table2.key3' => 5} 




2572




 





 





 





 





 





 



   




2573




 





 





 





 





 





 



 Parameter shown before where clause. 




2574




 





 





 





 





 





 



    




2575




 





 





 





 





 





 



 For example, if you want to contain named placeholder in join clause,  




2576




 





 





 





 





 





 



 you can pass parameter by C option. 




2577




 





 





 





 





 





 



   




2578




 





 





 





 





 





 



   join  => ['inner join (select * from table2 where table2.key3 = :table2.key3)' .  




2579




 





 





 





 





 





 



             ' as table2 on table1.key1 = table2.key1'] 




2580




 





 





 





 





 





 



   




2581




 





 





 





 





 





 



 =item prefix 




2582




 





 





 





 





 





 



   




2583




 





 





 





 





 





 



   prefix => 'SQL_CALC_FOUND_ROWS' 




2584




 





 





 





 





 





 



   




2585




 





 





 





 





 





 



 Prefix of column clause 




2586




 





 





 





 





 





 



   




2587




 





 





 





 





 





 



   select SQL_CALC_FOUND_ROWS title, author from book; 




2588




 





 





 





 





 





 



   




2589




 





 





 





 





 





 



 =item join 




2590




 





 





 





 





 





 



   




2591




 





 





 





 





 





 



   join => [ 




2592




 





 





 





 





 





 



     'left outer join company on book.company_id = company_id', 




2593




 





 





 





 





 





 



     'left outer join location on company.location_id = location.id' 




2594




 





 





 





 





 





 



   ] 




2595




 





 





 





 





 





 



        




2596




 





 





 





 





 





 



 Join clause. If column clause or where clause contain table name like "company.name", 




2597




 





 





 





 





 





 



 join clauses needed when SQL is created is used automatically. 




2598




 





 





 





 





 





 



   




2599




 





 





 





 





 





 



   $dbi->select( 




2600




 





 





 





 





 





 



     table => 'book', 




2601




 





 





 





 





 





 



     column => ['company.location_id as location_id'], 




2602




 





 





 





 





 





 



     where => {'company.name' => 'Orange'}, 




2603




 





 





 





 





 





 



     join => [ 




2604




 





 





 





 





 





 



       'left outer join company on book.company_id = company.id', 




2605




 





 





 





 





 





 



       'left outer join location on company.location_id = location.id' 




2606




 





 





 





 





 





 



     ] 




2607




 





 





 





 





 





 



   ); 




2608




 





 





 





 





 





 



   




2609




 





 





 





 





 





 



 In above select, column and where clause contain "company" table, 




2610




 





 





 





 





 





 



 the following SQL is created 




2611




 





 





 





 





 





 



   




2612




 





 





 





 





 





 



   select company.location_id as location_id 




2613




 





 





 





 





 





 



   from book 




2614




 





 





 





 





 





 



     left outer join company on book.company_id = company.id 




2615




 





 





 





 





 





 



   where company.name = ?; 




2616




 





 





 





 





 





 



   




2617




 





 





 





 





 





 



 You can specify two table by yourself. This is useful when join parser can't parse 




2618




 





 





 





 





 





 



 the join clause correctly. 




2619




 





 





 





 





 





 



   




2620




 





 





 





 





 





 



   $dbi->select( 




2621




 





 





 





 





 





 



     table => 'book', 




2622




 





 





 





 





 





 



     column => ['company.location_id as location_id'], 




2623




 





 





 





 





 





 



     where => {'company.name' => 'Orange'}, 




2624




 





 





 





 





 





 



     join => [ 




2625




 





 





 





 





 





 



       { 




2626




 





 





 





 





 





 



         clause => 'left outer join location on company.location_id = location.id', 




2627




 





 





 





 





 





 



         table => ['company', 'location'] 




2628




 





 





 





 





 





 



       } 




2629




 





 





 





 





 





 



     ] 




2630




 





 





 





 





 





 



   ); 




2631




 





 





 





 





 





 



   




2632




 





 





 





 





 





 



 =item table 




2633




 





 





 





 





 





 



   




2634




 





 





 





 





 





 



   table => 'book' 




2635




 





 





 





 





 





 



   




2636




 





 





 





 





 





 



 Table name. 




2637




 





 





 





 





 





 



   




2638




 





 





 





 





 





 



 =item where 




2639




 





 





 





 





 





 



    




2640




 





 





 





 





 





 



   # (1) Hash reference 




2641




 





 





 





 





 





 



   where => {author => 'Ken', 'title' => ['Perl', 'Ruby']} 




2642




 





 





 





 





 





 



   # -> where author = 'Ken' and title in ('Perl', 'Ruby') 




2643




 





 





 





 





 





 



    




2644




 





 





 





 





 





 



   # (2) DBIx::Custom::Where object 




2645




 





 





 





 





 





 



   where => $dbi->where( 




2646




 





 





 





 





 





 



     clause => ['and', ':author{=}', ':title{like}'], 




2647




 





 





 





 





 





 



     param  => {author => 'Ken', title => '%Perl%'} 




2648




 





 





 





 





 





 



   ) 




2649




 





 





 





 





 





 



   # -> where author = 'Ken' and title like '%Perl%' 




2650




 





 





 





 





 





 



    




2651




 





 





 





 





 





 



   # (3) Array reference[where clause, parameters, join(optional)] 




2652




 





 





 





 





 





 



   where => [ 




2653




 





 





 





 





 





 



     ['and', ':author{=}', ':title{like}'], 




2654




 





 





 





 





 





 



     {author => 'Ken', title => '%Perl%'}, 




2655




 





 





 





 





 





 



     ["left outer join table2 on table1.key1 = table2.key1"] 




2656




 





 





 





 





 





 



   ] 




2657




 





 





 





 





 





 



   # -> where author = 'Ken' and title like '%Perl%' 




2658




 





 





 





 





 





 



    




2659




 





 





 





 





 





 



   # (4) Array reference[String, Hash reference] 




2660




 





 





 





 





 





 



   where => [ 




2661




 





 





 





 





 





 



     ':author{=} and :title{like}', 




2662




 





 





 





 





 





 



     {author => 'Ken', title => '%Perl%'} 




2663




 





 





 





 





 





 



   ] 




2664




 





 





 





 





 





 



   #  -> where author = 'Ken' and title like '%Perl%' 




2665




 





 





 





 





 





 



    




2666




 





 





 





 





 





 



   # (5) String 




2667




 





 





 





 





 





 



   where => 'title is null' 




2668




 





 





 





 





 





 



   #  -> where title is null 




2669




 





 





 





 





 





 



   




2670




 





 





 





 





 





 



 Where clause. 




2671




 





 





 





 





 





 



 See also L to know how to create where clause. 




2672




 





 





 





 





 





 



    




2673




 





 





 





 





 





 



 =back 




2674




 





 





 





 





 





 



   




2675




 





 





 





 





 





 



 =head2 type_rule 




2676




 





 





 





 





 





 



   




2677




 





 





 





 





 





 



   $dbi->type_rule( 




2678




 





 





 





 





 





 



     into1 => { 




2679




 





 





 





 





 





 



       date => sub { ... }, 




2680




 





 





 





 





 





 



       datetime => sub { ... } 




2681




 





 





 





 





 





 



     }, 




2682




 





 





 





 





 





 



     into2 => { 




2683




 





 





 





 





 





 



       date => sub { ... }, 




2684




 





 





 





 





 





 



       datetime => sub { ... } 




2685




 





 





 





 





 





 



     }, 




2686




 





 





 





 





 





 



     from1 => { 




2687




 





 





 





 





 





 



       # DATE 




2688




 





 





 





 





 





 



       9 => sub { ... }, 




2689




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2690




 





 





 





 





 





 



       11 => sub { ... }, 




2691




 





 





 





 





 





 



     } 




2692




 





 





 





 





 





 



     from2 => { 




2693




 





 





 





 





 





 



       # DATE 




2694




 





 





 





 





 





 



       9 => sub { ... }, 




2695




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2696




 





 





 





 





 





 



       11 => sub { ... }, 




2697




 





 





 





 





 





 



     } 




2698




 





 





 





 





 





 



   ); 




2699




 





 





 





 





 





 



   




2700




 





 





 





 





 





 



 Filtering rule when data is send into and get from database. 




2701




 





 





 





 





 





 



 This has a little complex problem. 




2702




 





 





 





 





 





 



   




2703




 





 





 





 





 





 



 In C and C you can specify 




2704




 





 





 





 





 





 



 type name as same as type name defined 




2705




 





 





 





 





 





 



 by create table, such as C or C. 




2706




 





 





 





 





 





 



   




2707




 





 





 





 





 





 



 Note that type name and data type don't contain upper case. 




2708




 





 





 





 





 





 



 If these contain upper case character, you convert it to lower case. 




2709




 





 





 





 





 





 



   




2710




 





 





 





 





 





 



 C is executed after C. 




2711




 





 





 





 





 





 



   




2712




 





 





 





 





 





 



 Type rule of C and C is enabled on the following 




2713




 





 





 





 





 





 



 column name. 




2714




 





 





 





 





 





 



   




2715




 





 





 





 





 





 



 =over 4 




2716




 





 





 





 





 





 



   




2717




 





 





 





 





 





 



 =item 1. column name 




2718




 





 





 





 





 





 



   




2719




 





 





 





 





 





 



   issue_date 




2720




 





 





 





 





 





 



   issue_datetime 




2721




 





 





 





 





 





 



   




2722




 





 





 





 





 





 



 This need C option in each method. 




2723




 





 





 





 





 





 



   




2724




 





 





 





 





 





 



 =item 2. table name and column name, separator is dot 




2725




 





 





 





 





 





 



   




2726




 





 





 





 





 





 



   book.issue_date 




2727




 





 





 





 





 





 



   book.issue_datetime 




2728




 





 





 





 





 





 



   




2729




 





 





 





 





 





 



 =back 




2730




 





 





 





 





 





 



   




2731




 





 





 





 





 





 



 You get all type name used in database by C. 




2732




 





 





 





 





 





 



   




2733




 





 





 





 





 





 



   print $dbi->available_typename; 




2734




 





 





 





 





 





 



   




2735




 





 





 





 





 





 



 In C and C you specify data type, not type name. 




2736




 





 





 





 





 





 



 C is executed after C. 




2737




 





 





 





 





 





 



 You get all data type by C. 




2738




 





 





 





 





 





 



   




2739




 





 





 





 





 





 



   print $dbi->available_datatype; 




2740




 





 





 





 





 





 



   




2741




 





 





 





 





 





 



 You can also specify multiple types at once. 




2742




 





 





 





 





 





 



   




2743




 





 





 





 





 





 



   $dbi->type_rule( 




2744




 





 





 





 





 





 



     into1 => [ 




2745




 





 





 





 





 





 



       [qw/DATE DATETIME/] => sub { ... }, 




2746




 





 





 





 





 





 



     ], 




2747




 





 





 





 





 





 



   ); 




2748




 





 





 





 





 





 



   




2749




 





 





 





 





 





 



 =head2 update 




2750




 





 





 





 





 





 



   




2751




 





 





 





 





 





 



   $dbi->update({title => 'Perl'}, table  => 'book', where  => {id => 4}); 




2752




 





 





 





 





 





 



   




2753




 





 





 





 





 





 



 Execute update statement. First argument is update row data. 




2754




 





 





 





 





 





 



   




2755




 





 





 





 





 





 



 If you want to set constant value to row data, use scalar reference 




2756




 





 





 





 





 





 



 as parameter value. 




2757




 





 





 





 





 





 



   




2758




 





 





 





 





 





 



   {date => \"NOW()"} 




2759




 





 





 





 





 





 



   




2760




 





 





 





 





 





 



 B 




2761




 





 





 





 





 





 



   




2762




 





 





 





 





 





 



 C method use all of C method's options, 




2763




 





 





 





 





 





 



 and use the following new ones. 




2764




 





 





 





 





 





 



   




2765




 





 





 





 





 





 



 =over 4 




2766




 





 





 





 





 





 



   




2767




 





 





 





 





 





 



 =item prefix 




2768




 





 





 





 





 





 



   




2769




 





 





 





 





 





 



   prefix => 'or replace' 




2770




 





 





 





 





 





 



   




2771




 





 





 





 





 





 



 prefix before table name section 




2772




 





 





 





 





 





 



   




2773




 





 





 





 





 





 



   update or replace book 




2774




 





 





 





 





 





 



   




2775




 





 





 





 





 





 



 =item table 




2776




 





 





 





 





 





 



   




2777




 





 





 





 





 





 



   table => 'book' 




2778




 





 





 





 





 





 



   




2779




 





 





 





 





 





 



 Table name. 




2780




 





 





 





 





 





 



   




2781




 





 





 





 





 





 



 =item where 




2782




 





 





 





 





 





 



   




2783




 





 





 





 





 





 



 Same as C method's C option. 




2784




 





 





 





 





 





 



   




2785




 





 





 





 





 





 



 =item wrap 




2786




 





 





 





 





 





 



   




2787




 





 





 





 





 





 



   wrap => {price => sub { "max($_[0])" }} 




2788




 





 





 





 





 





 



   




2789




 





 





 





 





 





 



 placeholder wrapped string. 




2790




 





 





 





 





 





 



   




2791




 





 





 





 





 





 



 If the following statement 




2792




 





 





 





 





 





 



   




2793




 





 





 





 





 





 



   $dbi->update({price => 100}, table => 'book', 




2794




 





 





 





 





 





 



     {price => sub { "$_[0] + 5" }}); 




2795




 





 





 





 





 





 



   




2796




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2797




 





 





 





 





 





 



   




2798




 





 





 





 





 





 



   update book set price =  ? + 5; 




2799




 





 





 





 





 





 



   




2800




 





 





 





 





 





 



 =item mtime 




2801




 





 





 





 





 





 



   




2802




 





 





 





 





 





 



   mtime => 'modified_time' 




2803




 





 





 





 





 





 



   




2804




 





 





 





 





 





 



 Modified time column name. time row is updated is set to the column. 




2805




 





 





 





 





 





 



 default time format is C, which can be changed by 




2806




 





 





 





 





 





 



 C attribute. 




2807




 





 





 





 





 





 



   




2808




 





 





 





 





 





 



 =back 




2809




 





 





 





 





 





 



   




2810




 





 





 





 





 





 



 =head2 update_all 




2811




 





 





 





 





 





 



   




2812




 





 





 





 





 





 



   $dbi->update_all({title => 'Perl'}, table => 'book', ); 




2813




 





 





 





 





 





 



   




2814




 





 





 





 





 





 



 Execute update statement for all rows. 




2815




 





 





 





 





 





 



 Options is same as C method. 




2816




 





 





 





 





 





 



   




2817




 





 





 





 





 





 



 =over 4 




2818




 





 





 





 





 





 



   




2819




 





 





 





 





 





 



 =item option 




2820




 





 





 





 





 





 



   




2821




 





 





 





 





 





 



   option => { 




2822




 





 





 





 





 





 



     select => { 




2823




 





 





 





 





 





 



       append => '...' 




2824




 





 





 





 





 





 



     }, 




2825




 





 





 





 





 





 



     insert => { 




2826




 





 





 





 





 





 



       prefix => '...' 




2827




 





 





 





 





 





 



     }, 




2828




 





 





 





 





 





 



     update => { 




2829




 





 





 





 





 





 



       filter => {} 




2830




 





 





 





 





 





 



     } 




2831




 





 





 





 





 





 



   } 




2832




 





 





 





 





 





 



   




2833




 





 





 





 





 





 



 If you want to pass option to each method, 




2834




 





 





 





 





 





 



 you can use C option. 




2835




 





 





 





 





 





 



   




2836




 





 





 





 





 





 



 =over 4 




2837




 





 





 





 





 





 



   




2838




 





 





 





 





 





 



 =item select_option 




2839




 





 





 





 





 





 



   




2840




 





 





 





 





 





 



   select_option => {append => 'for update'} 




2841




 





 





 





 





 





 



   




2842




 





 





 





 





 





 



 select method option, 




2843




 





 





 





 





 





 



 select method is used to check the row is already exists. 




2844




 





 





 





 





 





 



   




2845




 





 





 





 





 





 



 =head2 show_datatype 




2846




 





 





 





 





 





 



   




2847




 





 





 





 





 





 



   $dbi->show_datatype($table); 




2848




 





 





 





 





 





 



   




2849




 





 





 





 





 





 



 Show data type of the columns of specified table. 




2850




 





 





 





 





 





 



   




2851




 





 





 





 





 





 



   book 




2852




 





 





 





 





 





 



   title: 5 




2853




 





 





 





 





 





 



   issue_date: 91 




2854




 





 





 





 





 





 



   




2855




 





 





 





 





 





 



 This data type is used in C's C and C. 




2856




 





 





 





 





 





 



   




2857




 





 





 





 





 





 



 =head2 show_tables 




2858




 





 





 





 





 





 



   




2859




 





 





 





 





 





 



   $dbi->show_tables; 




2860




 





 





 





 





 





 



   




2861




 





 





 





 





 





 



 Show tables. 




2862




 





 





 





 





 





 



   




2863




 





 





 





 





 





 



 =head2 show_typename 




2864




 





 





 





 





 





 



   




2865




 





 





 





 





 





 



   $dbi->show_typename($table); 




2866




 





 





 





 





 





 



   




2867




 





 





 





 





 





 



 Show type name of the columns of specified table. 




2868




 





 





 





 





 





 



   




2869




 





 





 





 





 





 



   book 




2870




 





 





 





 





 





 



   title: varchar 




2871




 





 





 





 





 





 



   issue_date: date 




2872




 





 





 





 





 





 



   




2873




 





 





 





 





 





 



 This type name is used in C's C and C. 




2874




 





 





 





 





 





 



   




2875




 





 





 





 





 





 



 =head2 values_clause 




2876




 





 





 





 





 





 



   




2877




 





 





 





 





 





 



   my $values_clause = $dbi->values_clause({title => 'a', age => 2}); 




2878




 





 





 





 





 





 



   




2879




 





 





 





 





 





 



 Create values clause. 




2880




 





 





 





 





 





 



   




2881




 





 





 





 





 





 



   (title, author) values (title = :title, age = :age); 




2882




 





 





 





 





 





 



   




2883




 





 





 





 





 





 



 You can use this in insert statement. 




2884




 





 





 





 





 





 



   




2885




 





 





 





 





 





 



   my $insert_sql = "insert into book $values_clause"; 




2886




 





 





 





 





 





 



   




2887




 





 





 





 





 





 



 =head2 where 




2888




 





 





 





 





 





 



   




2889




 





 





 





 





 





 



   my $where = $dbi->where; 




2890




 





 





 





 





 





 



   $where->clause(['and', 'title = :title', 'author = :author']); 




2891




 





 





 





 





 





 



   $where->param({title => 'Perl', author => 'Ken'}); 




2892




 





 





 





 





 





 



   $where->join(['left join author on book.author = author.id]); 




2893




 





 





 





 





 





 



   




2894




 





 





 





 





 





 



 Create a new L object. 




2895




 





 





 





 





 





 



 See L to know how to create where clause. 




2896




 





 





 





 





 





 



   




2897




 





 





 





 





 





 



 =head1 ENVIRONMENTAL VARIABLES 




2898




 





 





 





 





 





 



   




2899




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG 




2900




 





 





 





 





 





 



   




2901




 





 





 





 





 





 



 If environment variable C is set to true, 




2902




 





 





 





 





 





 



 executed SQL and bind values are printed to STDERR. 




2903




 





 





 





 





 





 



   




2904




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG_ENCODING 




2905




 





 





 





 





 





 



   




2906




 





 





 





 





 





 



 DEBUG output encoding. Default to UTF-8. 




2907




 





 





 





 





 





 



   




2908




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION 




2909




 





 





 





 





 





 



   




2910




 





 





 





 





 





 



   $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25'; 




2911




 





 





 





 





 





 



   




2912




 





 





 





 





 





 



 Suppress deprecation warnings before specified version. 




2913




 





 





 





 





 





 



   




2914




 





 





 





 





 





 



 =head1 DEPRECATED FUNCTIONALITY 




2915




 





 





 





 





 





 



   




2916




 





 





 





 





 





 



 L 




2917




 





 





 





 





 





 



   




2918




 





 





 





 





 





 



   # Methods 




2919




 





 





 





 





 





 



   DBIx::Custom AUTOLOAD feature # will be removed at 2022/5/1 




2920




 





 





 





 





 





 



   DBIx::Custom::helper method # will be removed at 2022/5/1 




2921




 





 





 





 





 





 



   DBIx::Custom::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1 




2922




 





 





 





 





 





 



   DBIx::Custom::count method # will be removed at 2022/5/1 




2923




 





 





 





 





 





 



   DBIx::Custom::select,update,delete method's primary_key option is DEPRECATED! # will be removed at 2022/5/1 




2924




 





 





 





 





 





 



   DBIx::Custom::select,update,delete method's id option is DEPRECATED! # will be removed at 2022/5/1 




2925




 





 





 





 





 





 



   DBIx::Custom::setup method is DEPRECATED! # will be removed at 2022/5/1 




2926




 





 





 





 





 





 



   




2927




 





 





 





 





 





 



 L 




2928




 





 





 





 





 





 



    




2929




 





 





 





 





 





 



   # Options 




2930




 





 





 





 





 





 



   kv method's multi option (from 0.28) # will be removed at 2018/3/1 




2931




 





 





 





 





 





 



   




2932




 





 





 





 





 





 



 L 




2933




 





 





 





 





 





 



   




2934




 





 





 





 





 





 



   DBIx::Custom::Model AUTOLOAD feature # will be removed at 2022/5/1 




2935




 





 





 





 





 





 



   DBIx::Custom::Model::helper method is DEPRECATED! # will be removed at 2022/5/1 




2936




 





 





 





 





 





 



   DBIx::Custom::Model::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1 




2937




 





 





 





 





 





 



   DBIx::Custom::Model::count method # will be removed at 2022/5/1 




2938




 





 





 





 





 





 



   DBIx::Custom::Model::primary_key attribute is DEPRECATED! # will be removed at 2022/5/1 




2939




 





 





 





 





 





 



   




2940




 





 





 





 





 





 



 =head1 BACKWARDS COMPATIBILITY POLICY 




2941




 





 





 





 





 





 



   




2942




 





 





 





 





 





 



 If a feature is DEPRECATED, you can know it by DEPRECATED warnings. 




2943




 





 





 





 





 





 



 DEPRECATED feature is removed after C, 




2944




 





 





 





 





 





 



 but if at least one person use the feature and tell me that thing 




2945




 





 





 





 





 





 



 I extend one year each time he tell me it. 




2946




 





 





 





 





 





 



   




2947




 





 





 





 





 





 



 DEPRECATION warnings can be suppressed by C 




2948




 





 





 





 





 





 



 environment variable. 




2949




 





 





 





 





 





 



   




2950




 





 





 





 





 





 



 EXPERIMENTAL features will be changed or deleted without warnings. 




2951




 





 





 





 





 





 



   




2952




 





 





 





 





 





 



 =head1 BUGS 




2953




 





 





 





 





 





 



   




2954




 





 





 





 





 





 



 Please tell me bugs if you find bug. 




2955




 





 





 





 





 





 



   




2956




 





 





 





 





 





 



 C<<  >> 




2957




 





 





 





 





 





 



   




2958




 





 





 





 





 





 



 L 




2959




 





 





 





 





 





 



   




2960




 





 





 





 





 





 



 =head1 AUTHOR 




2961




 





 





 





 





 





 



   




2962




 





 





 





 





 





 



 Yuki Kimoto, C<<  >> 




2963




 





 





 





 





 





 



   




2964




 





 





 





 





 





 



 =head1 COPYRIGHT & LICENSE 




2965




 





 





 





 





 





 



   




2966




 





 





 





 





 





 



 Copyright 2009-2019 Yuki Kimoto, all rights reserved. 




2967




 





 





 





 





 





 



   




2968




 





 





 





 





 





 



 This program is free software; you can redistribute it and/or modify it 




2969




 





 





 





 





 





 



 under the same terms as Perl itself. 




2970




 





 





 





 





 





 



   




2971




 





 





 





 





 





 



 =cut

  $dbi->execute("select * from book where title = :title and author = :author",
    {title => 'Perl', author => 'Ken', table => 'book');

  # Same
  $dbi->execute(
    "select * from book where title = :book.title and author = :book.author",
    {title => 'Perl', author => 'Ken');

=item table_alias

  table_alias => {worker => 'user'} # {ALIAS => TABLE}

Table alias. Key is alias table name, value is real table name, .
If you set C, you can enable C and C type rule
on alias table name.

=item type_rule_off

  type_rule_off => 1

Turn C and C type rule off.

=item type_rule1_off

  type_rule1_off => 1

Turn C type rule off.

=item type_rule2_off

  type_rule2_off => 1

Turn C type rule off.

=item prepare_attr

  prepare_attr => {mysql_use_result => 1}

Statemend handle attributes,
this is L's C method second argument.

=head2 get_column_info

  my $column_infos = $dbi->get_column_info(exclude_table => qr/^system_/);

get column information except for one which match C pattern.

  [
    {table => 'book', column => 'title', info => {...}},
    {table => 'author', column => 'name' info => {...}}
  ]

=head2 get_table_info

  my $table_infos = $dbi->get_table_info(exclude => qr/^system_/);

get table information except for one which match C pattern.

  [
    {table => 'book', info => {...}},
    {table => 'author', info => {...}}
  ]

You can set this value to C.

=head2 insert

  $dbi->insert({title => 'Perl', author => 'Ken'}, table  => 'book');

Execute insert statement. First argument is row data. Return value is
affected row count.

If you want to set constant value to row data, use scalar reference
as parameter value.

  {date => \"NOW()"}

You can pass multiple parameters, this is very fast.

  $dbi->insert(
    [
      {title => 'Perl', author => 'Ken'},
      {title => 'Ruby', author => 'Tom'}
    ],
    table  => 'book'
  );

In multiple insert, you can't use C option.
and only first parameter is used to create sql.

B

C method use all of C method's options,
and use the following new ones.

=over 4

=item bulk_insert

  bulk_insert => 1

bulk insert is executed if database support bulk insert and
multiple parameters is passed to C.
The SQL like the following one is executed.

  insert into book (id, title) values (?, ?), (?, ?);

=item ctime

  ctime => 'created_time'

Created time column name. time when row is created is set to the column.
default time format is "YYYY-mm-dd HH:MM:SS", which can be changed by
C attribute.

=item prefix

  prefix => 'or replace'

prefix before table name section

  insert or replace into book

=item table

  table => 'book'

Table name.

=item mtime

This option is same as C method C option.

=item wrap

  wrap => {price => sub { "max($_[0])" }}

placeholder wrapped string.

If the following statement

  $dbi->insert({price => 100}, table => 'book',
    {price => sub { "$_[0] + 5" }});

is executed, the following SQL is executed.

  insert into book price values ( ? + 5 );

=back

=over 4

=head2 include_model

  $dbi->include_model('MyModel');

Include models from specified namespace,
the following layout is needed to include models.

  lib / MyModel.pm
      / MyModel / book.pm
                / company.pm

Name space module, extending L.

B

  package MyModel;
  use DBIx::Custom::Model -base;

  1;

Model modules, extending name space module.

B

  package MyModel::book;
  use MyModel -base;

  1;

B

  package MyModel::company;
  use MyModel -base;

  1;

MyModel::book and MyModel::company is included by C.

You can get model object by C.

  my $book_model = $dbi->model('book');
  my $company_model = $dbi->model('company');

You can include full-qualified table name like C

  lib / MyModel.pm
      / MyModel / main / book.pm
                       / company.pm

  my $main_book = $self->model('main.book');

See L to know model features.

=head2 like_value

  my $like_value = $dbi->like_value

Code reference which return a value for the like value.

  sub { "%$_[0]%" }

=head2 mapper

  my $mapper = $dbi->mapper(param => $param);

Create a new L object.

=head2 merge_param

  my $param = $dbi->merge_param({key1 => 1}, {key1 => 1, key2 => 2});

Merge parameters. The following new parameter is created.

  {key1 => [1, 1], key2 => 2}

If same keys contains, the value is converted to array reference.

=head2 model

  my $model = $dbi->model('book');

Get a L object
create by C or C

=head2 mycolumn

  my $column = $dbi->mycolumn(book => ['author', 'title']);

Create column clause for myself. The following column clause is created.

  book.author as author,
  book.title as title

=head2 new

  my $dbi = DBIx::Custom->new(
    dsn => "dbi:mysql:database=dbname",
    user => 'ken',
    password => '!LFKD%$&',
    option => {mysql_enable_utf8 => 1}
  );

Create a new L object.

=head2 not_exists

  my $not_exists = $dbi->not_exists;

DBIx::Custom::NotExists object, indicating the column is not exists.
This is used in C of L .

=head2 order

  my $order = $dbi->order;

Create a new L object.

=head2 q

  my $quooted = $dbi->q("title");

Quote string by value of C.

=head2 register_filter

  $dbi->register_filter(
    # Time::Piece object to database DATE format
    tp_to_date => sub {
      my $tp = shift;
      return $tp->strftime('%Y-%m-%d');
    },
    # database DATE format to Time::Piece object
    date_to_tp => sub {
      my $date = shift;
      return Time::Piece->strptime($date, '%Y-%m-%d');
    }
  );

Register filters, used by C option of many methods.

=head2 select

  my $result = $dbi->select(
    column => ['author', 'title'],
    table  => 'book',
    where  => {author => 'Ken'},
  );

Execute select statement.

You can pass odd number arguments. first argument is C.

  my $result = $dbi->select(['author', 'title'], table => 'book');

B

C method use all of C method's options,
and use the following new ones.

=over 4

=item column

  column => 'author'
  column => ['author', 'title']

Column clause.

if C is not specified, '*' is set.

  column => '*'

You can specify hash of array reference.

  column => [
    {book => [qw/author title/]},
    {person => [qw/name age/]}
  ]

This is expanded to the following one by using C method.

  book.author as "book.author",
  book.title as "book.title",
  person.name as "person.name",
  person.age as "person.age"

You can specify own column by C<__MY__>.

  column => [
    {__MY__ => [qw/author title/]},
  ]

This is expanded to the following one by using C method.

  book.author as "author",
  book.title as "title",

C<__MY__> can be changed by C attribute.

=item param

  param => {'table2.key3' => 5}

Parameter shown before where clause.

For example, if you want to contain named placeholder in join clause,
you can pass parameter by C option.

  join  => ['inner join (select * from table2 where table2.key3 = :table2.key3)' .
            ' as table2 on table1.key1 = table2.key1']

=item prefix

  prefix => 'SQL_CALC_FOUND_ROWS'

Prefix of column clause

  select SQL_CALC_FOUND_ROWS title, author from book;

=item join

  join => [
    'left outer join company on book.company_id = company_id',
    'left outer join location on company.location_id = location.id'
  ]

Join clause. If column clause or where clause contain table name like "company.name",
join clauses needed when SQL is created is used automatically.

  $dbi->select(
    table => 'book',
    column => ['company.location_id as location_id'],
    where => {'company.name' => 'Orange'},
    join => [
      'left outer join company on book.company_id = company.id',
      'left outer join location on company.location_id = location.id'
    ]
  );

In above select, column and where clause contain "company" table,
the following SQL is created

  select company.location_id as location_id
  from book
    left outer join company on book.company_id = company.id
  where company.name = ?;

You can specify two table by yourself. This is useful when join parser can't parse
the join clause correctly.

  $dbi->select(
    table => 'book',
    column => ['company.location_id as location_id'],
    where => {'company.name' => 'Orange'},
    join => [
      {
        clause => 'left outer join location on company.location_id = location.id',
        table => ['company', 'location']
      }
    ]
  );

=item table

  table => 'book'

Table name.

=item where

  # (1) Hash reference
  where => {author => 'Ken', 'title' => ['Perl', 'Ruby']}
  # -> where author = 'Ken' and title in ('Perl', 'Ruby')

  # (2) DBIx::Custom::Where object
  where => $dbi->where(
    clause => ['and', ':author{=}', ':title{like}'],
    param  => {author => 'Ken', title => '%Perl%'}
  )
  # -> where author = 'Ken' and title like '%Perl%'

  # (3) Array reference[where clause, parameters, join(optional)]
  where => [
    ['and', ':author{=}', ':title{like}'],
    {author => 'Ken', title => '%Perl%'},
    ["left outer join table2 on table1.key1 = table2.key1"]
  ]
  # -> where author = 'Ken' and title like '%Perl%'

  # (4) Array reference[String, Hash reference]
  where => [
    ':author{=} and :title{like}',
    {author => 'Ken', title => '%Perl%'}
  ]
  #  -> where author = 'Ken' and title like '%Perl%'

  # (5) String
  where => 'title is null'
  #  -> where title is null

Where clause.
See also L to know how to create where clause.

=back

=head2 type_rule

  $dbi->type_rule(
    into1 => {
      date => sub { ... },
      datetime => sub { ... }
    },
    into2 => {
      date => sub { ... },
      datetime => sub { ... }
    },
    from1 => {
      # DATE
      9 => sub { ... },
      # DATETIME or TIMESTAMP
      11 => sub { ... },
    }
    from2 => {
      # DATE
      9 => sub { ... },
      # DATETIME or TIMESTAMP
      11 => sub { ... },
    }
  );

Filtering rule when data is send into and get from database.
This has a little complex problem.

In C and C you can specify
type name as same as type name defined
by create table, such as C or C.

Note that type name and data type don't contain upper case.
If these contain upper case character, you convert it to lower case.

C is executed after C.

Type rule of C and C is enabled on the following
column name.

=over 4

=item 1. column name

  issue_date
  issue_datetime

This need C option in each method. 




2723




 





 





 





 





 





 



   




2724




 





 





 





 





 





 



 =item 2. table name and column name, separator is dot 




2725




 





 





 





 





 





 



   




2726




 





 





 





 





 





 



   book.issue_date 




2727




 





 





 





 





 





 



   book.issue_datetime 




2728




 





 





 





 





 





 



   




2729




 





 





 





 





 





 



 =back 




2730




 





 





 





 





 





 



   




2731




 





 





 





 





 





 



 You get all type name used in database by C. 




2732




 





 





 





 





 





 



   




2733




 





 





 





 





 





 



   print $dbi->available_typename; 




2734




 





 





 





 





 





 



   




2735




 





 





 





 





 





 



 In C and C you specify data type, not type name. 




2736




 





 





 





 





 





 



 C is executed after C. 




2737




 





 





 





 





 





 



 You get all data type by C. 




2738




 





 





 





 





 





 



   




2739




 





 





 





 





 





 



   print $dbi->available_datatype; 




2740




 





 





 





 





 





 



   




2741




 





 





 





 





 





 



 You can also specify multiple types at once. 




2742




 





 





 





 





 





 



   




2743




 





 





 





 





 





 



   $dbi->type_rule( 




2744




 





 





 





 





 





 



     into1 => [ 




2745




 





 





 





 





 





 



       [qw/DATE DATETIME/] => sub { ... }, 




2746




 





 





 





 





 





 



     ], 




2747




 





 





 





 





 





 



   ); 




2748




 





 





 





 





 





 



   




2749




 





 





 





 





 





 



 =head2 update 




2750




 





 





 





 





 





 



   




2751




 





 





 





 





 





 



   $dbi->update({title => 'Perl'}, table  => 'book', where  => {id => 4}); 




2752




 





 





 





 





 





 



   




2753




 





 





 





 





 





 



 Execute update statement. First argument is update row data. 




2754




 





 





 





 





 





 



   




2755




 





 





 





 





 





 



 If you want to set constant value to row data, use scalar reference 




2756




 





 





 





 





 





 



 as parameter value. 




2757




 





 





 





 





 





 



   




2758




 





 





 





 





 





 



   {date => \"NOW()"} 




2759




 





 





 





 





 





 



   




2760




 





 





 





 





 





 



 B 




2761




 





 





 





 





 





 



   




2762




 





 





 





 





 





 



 C method use all of C method's options, 




2763




 





 





 





 





 





 



 and use the following new ones. 




2764




 





 





 





 





 





 



   




2765




 





 





 





 





 





 



 =over 4 




2766




 





 





 





 





 





 



   




2767




 





 





 





 





 





 



 =item prefix 




2768




 





 





 





 





 





 



   




2769




 





 





 





 





 





 



   prefix => 'or replace' 




2770




 





 





 





 





 





 



   




2771




 





 





 





 





 





 



 prefix before table name section 




2772




 





 





 





 





 





 



   




2773




 





 





 





 





 





 



   update or replace book 




2774




 





 





 





 





 





 



   




2775




 





 





 





 





 





 



 =item table 




2776




 





 





 





 





 





 



   




2777




 





 





 





 





 





 



   table => 'book' 




2778




 





 





 





 





 





 



   




2779




 





 





 





 





 





 



 Table name. 




2780




 





 





 





 





 





 



   




2781




 





 





 





 





 





 



 =item where 




2782




 





 





 





 





 





 



   




2783




 





 





 





 





 





 



 Same as C method's C option. 




2784




 





 





 





 





 





 



   




2785




 





 





 





 





 





 



 =item wrap 




2786




 





 





 





 





 





 



   




2787




 





 





 





 





 





 



   wrap => {price => sub { "max($_[0])" }} 




2788




 





 





 





 





 





 



   




2789




 





 





 





 





 





 



 placeholder wrapped string. 




2790




 





 





 





 





 





 



   




2791




 





 





 





 





 





 



 If the following statement 




2792




 





 





 





 





 





 



   




2793




 





 





 





 





 





 



   $dbi->update({price => 100}, table => 'book', 




2794




 





 





 





 





 





 



     {price => sub { "$_[0] + 5" }}); 




2795




 





 





 





 





 





 



   




2796




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2797




 





 





 





 





 





 



   




2798




 





 





 





 





 





 



   update book set price =  ? + 5; 




2799




 





 





 





 





 





 



   




2800




 





 





 





 





 





 



 =item mtime 




2801




 





 





 





 





 





 



   




2802




 





 





 





 





 





 



   mtime => 'modified_time' 




2803




 





 





 





 





 





 



   




2804




 





 





 





 





 





 



 Modified time column name. time row is updated is set to the column. 




2805




 





 





 





 





 





 



 default time format is C, which can be changed by 




2806




 





 





 





 





 





 



 C attribute. 




2807




 





 





 





 





 





 



   




2808




 





 





 





 





 





 



 =back 




2809




 





 





 





 





 





 



   




2810




 





 





 





 





 





 



 =head2 update_all 




2811




 





 





 





 





 





 



   




2812




 





 





 





 





 





 



   $dbi->update_all({title => 'Perl'}, table => 'book', ); 




2813




 





 





 





 





 





 



   




2814




 





 





 





 





 





 



 Execute update statement for all rows. 




2815




 





 





 





 





 





 



 Options is same as C method. 




2816




 





 





 





 





 





 



   




2817




 





 





 





 





 





 



 =over 4 




2818




 





 





 





 





 





 



   




2819




 





 





 





 





 





 



 =item option 




2820




 





 





 





 





 





 



   




2821




 





 





 





 





 





 



   option => { 




2822




 





 





 





 





 





 



     select => { 




2823




 





 





 





 





 





 



       append => '...' 




2824




 





 





 





 





 





 



     }, 




2825




 





 





 





 





 





 



     insert => { 




2826




 





 





 





 





 





 



       prefix => '...' 




2827




 





 





 





 





 





 



     }, 




2828




 





 





 





 





 





 



     update => { 




2829




 





 





 





 





 





 



       filter => {} 




2830




 





 





 





 





 





 



     } 




2831




 





 





 





 





 





 



   } 




2832




 





 





 





 





 





 



   




2833




 





 





 





 





 





 



 If you want to pass option to each method, 




2834




 





 





 





 





 





 



 you can use C option. 




2835




 





 





 





 





 





 



   




2836




 





 





 





 





 





 



 =over 4 




2837




 





 





 





 





 





 



   




2838




 





 





 





 





 





 



 =item select_option 




2839




 





 





 





 





 





 



   




2840




 





 





 





 





 





 



   select_option => {append => 'for update'} 




2841




 





 





 





 





 





 



   




2842




 





 





 





 





 





 



 select method option, 




2843




 





 





 





 





 





 



 select method is used to check the row is already exists. 




2844




 





 





 





 





 





 



   




2845




 





 





 





 





 





 



 =head2 show_datatype 




2846




 





 





 





 





 





 



   




2847




 





 





 





 





 





 



   $dbi->show_datatype($table); 




2848




 





 





 





 





 





 



   




2849




 





 





 





 





 





 



 Show data type of the columns of specified table. 




2850




 





 





 





 





 





 



   




2851




 





 





 





 





 





 



   book 




2852




 





 





 





 





 





 



   title: 5 




2853




 





 





 





 





 





 



   issue_date: 91 




2854




 





 





 





 





 





 



   




2855




 





 





 





 





 





 



 This data type is used in C's C and C. 




2856




 





 





 





 





 





 



   




2857




 





 





 





 





 





 



 =head2 show_tables 




2858




 





 





 





 





 





 



   




2859




 





 





 





 





 





 



   $dbi->show_tables; 




2860




 





 





 





 





 





 



   




2861




 





 





 





 





 





 



 Show tables. 




2862




 





 





 





 





 





 



   




2863




 





 





 





 





 





 



 =head2 show_typename 




2864




 





 





 





 





 





 



   




2865




 





 





 





 





 





 



   $dbi->show_typename($table); 




2866




 





 





 





 





 





 



   




2867




 





 





 





 





 





 



 Show type name of the columns of specified table. 




2868




 





 





 





 





 





 



   




2869




 





 





 





 





 





 



   book 




2870




 





 





 





 





 





 



   title: varchar 




2871




 





 





 





 





 





 



   issue_date: date 




2872




 





 





 





 





 





 



   




2873




 





 





 





 





 





 



 This type name is used in C's C and C. 




2874




 





 





 





 





 





 



   




2875




 





 





 





 





 





 



 =head2 values_clause 




2876




 





 





 





 





 





 



   




2877




 





 





 





 





 





 



   my $values_clause = $dbi->values_clause({title => 'a', age => 2}); 




2878




 





 





 





 





 





 



   




2879




 





 





 





 





 





 



 Create values clause. 




2880




 





 





 





 





 





 



   




2881




 





 





 





 





 





 



   (title, author) values (title = :title, age = :age); 




2882




 





 





 





 





 





 



   




2883




 





 





 





 





 





 



 You can use this in insert statement. 




2884




 





 





 





 





 





 



   




2885




 





 





 





 





 





 



   my $insert_sql = "insert into book $values_clause"; 




2886




 





 





 





 





 





 



   




2887




 





 





 





 





 





 



 =head2 where 




2888




 





 





 





 





 





 



   




2889




 





 





 





 





 





 



   my $where = $dbi->where; 




2890




 





 





 





 





 





 



   $where->clause(['and', 'title = :title', 'author = :author']); 




2891




 





 





 





 





 





 



   $where->param({title => 'Perl', author => 'Ken'}); 




2892




 





 





 





 





 





 



   $where->join(['left join author on book.author = author.id]); 




2893




 





 





 





 





 





 



   




2894




 





 





 





 





 





 



 Create a new L object. 




2895




 





 





 





 





 





 



 See L to know how to create where clause. 




2896




 





 





 





 





 





 



   




2897




 





 





 





 





 





 



 =head1 ENVIRONMENTAL VARIABLES 




2898




 





 





 





 





 





 



   




2899




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG 




2900




 





 





 





 





 





 



   




2901




 





 





 





 





 





 



 If environment variable C is set to true, 




2902




 





 





 





 





 





 



 executed SQL and bind values are printed to STDERR. 




2903




 





 





 





 





 





 



   




2904




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG_ENCODING 




2905




 





 





 





 





 





 



   




2906




 





 





 





 





 





 



 DEBUG output encoding. Default to UTF-8. 




2907




 





 





 





 





 





 



   




2908




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION 




2909




 





 





 





 





 





 



   




2910




 





 





 





 





 





 



   $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25'; 




2911




 





 





 





 





 





 



   




2912




 





 





 





 





 





 



 Suppress deprecation warnings before specified version. 




2913




 





 





 





 





 





 



   




2914




 





 





 





 





 





 



 =head1 DEPRECATED FUNCTIONALITY 




2915




 





 





 





 





 





 



   




2916




 





 





 





 





 





 



 L 




2917




 





 





 





 





 





 



   




2918




 





 





 





 





 





 



   # Methods 




2919




 





 





 





 





 





 



   DBIx::Custom AUTOLOAD feature # will be removed at 2022/5/1 




2920




 





 





 





 





 





 



   DBIx::Custom::helper method # will be removed at 2022/5/1 




2921




 





 





 





 





 





 



   DBIx::Custom::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1 




2922




 





 





 





 





 





 



   DBIx::Custom::count method # will be removed at 2022/5/1 




2923




 





 





 





 





 





 



   DBIx::Custom::select,update,delete method's primary_key option is DEPRECATED! # will be removed at 2022/5/1 




2924




 





 





 





 





 





 



   DBIx::Custom::select,update,delete method's id option is DEPRECATED! # will be removed at 2022/5/1 




2925




 





 





 





 





 





 



   DBIx::Custom::setup method is DEPRECATED! # will be removed at 2022/5/1 




2926




 





 





 





 





 





 



   




2927




 





 





 





 





 





 



 L 




2928




 





 





 





 





 





 



    




2929




 





 





 





 





 





 



   # Options 




2930




 





 





 





 





 





 



   kv method's multi option (from 0.28) # will be removed at 2018/3/1 




2931




 





 





 





 





 





 



   




2932




 





 





 





 





 





 



 L 




2933




 





 





 





 





 





 



   




2934




 





 





 





 





 





 



   DBIx::Custom::Model AUTOLOAD feature # will be removed at 2022/5/1 




2935




 





 





 





 





 





 



   DBIx::Custom::Model::helper method is DEPRECATED! # will be removed at 2022/5/1 




2936




 





 





 





 





 





 



   DBIx::Custom::Model::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1 




2937




 





 





 





 





 





 



   DBIx::Custom::Model::count method # will be removed at 2022/5/1 




2938




 





 





 





 





 





 



   DBIx::Custom::Model::primary_key attribute is DEPRECATED! # will be removed at 2022/5/1 




2939




 





 





 





 





 





 



   




2940




 





 





 





 





 





 



 =head1 BACKWARDS COMPATIBILITY POLICY 




2941




 





 





 





 





 





 



   




2942




 





 





 





 





 





 



 If a feature is DEPRECATED, you can know it by DEPRECATED warnings. 




2943




 





 





 





 





 





 



 DEPRECATED feature is removed after C, 




2944




 





 





 





 





 





 



 but if at least one person use the feature and tell me that thing 




2945




 





 





 





 





 





 



 I extend one year each time he tell me it. 




2946




 





 





 





 





 





 



   




2947




 





 





 





 





 





 



 DEPRECATION warnings can be suppressed by C 




2948




 





 





 





 





 





 



 environment variable. 




2949




 





 





 





 





 





 



   




2950




 





 





 





 





 





 



 EXPERIMENTAL features will be changed or deleted without warnings. 




2951




 





 





 





 





 





 



   




2952




 





 





 





 





 





 



 =head1 BUGS 




2953




 





 





 





 





 





 



   




2954




 





 





 





 





 





 



 Please tell me bugs if you find bug. 




2955




 





 





 





 





 





 



   




2956




 





 





 





 





 





 



 C<<  >> 




2957




 





 





 





 





 





 



   




2958




 





 





 





 





 





 



 L 




2959




 





 





 





 





 





 



   




2960




 





 





 





 





 





 



 =head1 AUTHOR 




2961




 





 





 





 





 





 



   




2962




 





 





 





 





 





 



 Yuki Kimoto, C<<  >> 




2963




 





 





 





 





 





 



   




2964




 





 





 





 





 





 



 =head1 COPYRIGHT & LICENSE 




2965




 





 





 





 





 





 



   




2966




 





 





 





 





 





 



 Copyright 2009-2019 Yuki Kimoto, all rights reserved. 




2967




 





 





 





 





 





 



   




2968




 





 





 





 





 





 



 This program is free software; you can redistribute it and/or modify it 




2969




 





 





 





 





 





 



 under the same terms as Perl itself. 




2970




 





 





 





 





 





 



   




2971




 





 





 





 





 





 



 =cut

=item 2. table name and column name, separator is dot

  book.issue_date
  book.issue_datetime

=back

You get all type name used in database by C.

  print $dbi->available_typename;

In C and C you specify data type, not type name.
C is executed after C.
You get all data type by C.

  print $dbi->available_datatype;

You can also specify multiple types at once.

  $dbi->type_rule(
    into1 => [
      [qw/DATE DATETIME/] => sub { ... },
    ],
  );

=head2 update

  $dbi->update({title => 'Perl'}, table  => 'book', where  => {id => 4});

Execute update statement. First argument is update row data.

If you want to set constant value to row data, use scalar reference
as parameter value.

  {date => \"NOW()"}

B

C method use all of C method's options,
and use the following new ones.

=over 4

=item prefix

  prefix => 'or replace'

prefix before table name section

  update or replace book

=item table

  table => 'book'

Table name.

=item where

Same as C method's C option.

=item wrap

  wrap => {price => sub { "max($_[0])" }}

placeholder wrapped string.

If the following statement

  $dbi->update({price => 100}, table => 'book',
    {price => sub { "$_[0] + 5" }});

is executed, the following SQL is executed.

  update book set price =  ? + 5;

=item mtime

  mtime => 'modified_time'

Modified time column name. time row is updated is set to the column.
default time format is C, which can be changed by
C attribute.

=back

=head2 update_all

  $dbi->update_all({title => 'Perl'}, table => 'book', );

Execute update statement for all rows.
Options is same as C method.

=over 4

=item option

  option => {
    select => {
      append => '...'
    },
    insert => {
      prefix => '...'
    },
    update => {
      filter => {}
    }
  }

If you want to pass option to each method,
you can use C option.

=over 4

=item select_option

  select_option => {append => 'for update'}

select method option,
select method is used to check the row is already exists.

=head2 show_datatype

  $dbi->show_datatype($table);

Show data type of the columns of specified table.

  book
  title: 5
  issue_date: 91

This data type is used in C's C and C.

=head2 show_tables

  $dbi->show_tables;

Show tables.

=head2 show_typename

  $dbi->show_typename($table);

Show type name of the columns of specified table.

  book
  title: varchar
  issue_date: date

This type name is used in C's C and C.

=head2 values_clause

  my $values_clause = $dbi->values_clause({title => 'a', age => 2});

Create values clause.

  (title, author) values (title = :title, age = :age);

You can use this in insert statement.

  my $insert_sql = "insert into book $values_clause";

=head2 where

  my $where = $dbi->where;
  $where->clause(['and', 'title = :title', 'author = :author']);
  $where->param({title => 'Perl', author => 'Ken'});
  $where->join(['left join author on book.author = author.id]);

Create a new L object.
See L to know how to create where clause.

=head1 ENVIRONMENTAL VARIABLES

=head2 DBIX_CUSTOM_DEBUG

If environment variable C is set to true,
executed SQL and bind values are printed to STDERR.

=head2 DBIX_CUSTOM_DEBUG_ENCODING

DEBUG output encoding. Default to UTF-8.

=head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION

  $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25';

Suppress deprecation warnings before specified version.

=head1 DEPRECATED FUNCTIONALITY

L

  # Methods
  DBIx::Custom AUTOLOAD feature # will be removed at 2022/5/1
  DBIx::Custom::helper method # will be removed at 2022/5/1
  DBIx::Custom::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1
  DBIx::Custom::count method # will be removed at 2022/5/1
  DBIx::Custom::select,update,delete method's primary_key option is DEPRECATED! # will be removed at 2022/5/1
  DBIx::Custom::select,update,delete method's id option is DEPRECATED! # will be removed at 2022/5/1
  DBIx::Custom::setup method is DEPRECATED! # will be removed at 2022/5/1

L

  # Options
  kv method's multi option (from 0.28) # will be removed at 2018/3/1

L

  DBIx::Custom::Model AUTOLOAD feature # will be removed at 2022/5/1
  DBIx::Custom::Model::helper method is DEPRECATED! # will be removed at 2022/5/1
  DBIx::Custom::Model::update_or_insert method is DEPRECATED! # will be removed at 2022/5/1
  DBIx::Custom::Model::count method # will be removed at 2022/5/1
  DBIx::Custom::Model::primary_key attribute is DEPRECATED! # will be removed at 2022/5/1

=head1 BACKWARDS COMPATIBILITY POLICY

If a feature is DEPRECATED, you can know it by DEPRECATED warnings.
DEPRECATED feature is removed after C,
but if at least one person use the feature and tell me that thing
I extend one year each time he tell me it.

DEPRECATION warnings can be suppressed by C
environment variable.

EXPERIMENTAL features will be changed or deleted without warnings.

=head1 BUGS

Please tell me bugs if you find bug.

C<<  >>

L

=head1 AUTHOR

Yuki Kimoto, C<<  >>

=head1 COPYRIGHT & LICENSE

Copyright 2009-2019 Yuki Kimoto, all rights reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut