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.45';

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__';

has 'column_name_lc';

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 column_name_lc;

Set NAME_lc in the Statement Handle Attributes to true when the DBI statement handle is created.

=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, 




2064




 





 





 





 





 





 



 C, and C. 




2065




 





 





 





 





 





 



   




2066




 





 





 





 





 





 



 If C is set, C method use C 




2067




 





 





 





 





 





 



 information, you can improve the performance of C in 




2068




 





 





 





 





 





 



 the following way. 




2069




 





 





 





 





 





 



   




2070




 





 





 





 





 





 



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




2071




 





 





 





 





 





 



   $dbi->user_column_info($column_info); 




2072




 





 





 





 





 





 



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




2073




 





 





 





 





 





 



   




2074




 





 





 





 





 





 



 =head2 each_table 




2075




 





 





 





 





 





 



   




2076




 





 





 





 





 





 



   $dbi->each_table( 




2077




 





 





 





 





 





 



     sub { 




2078




 





 





 





 





 





 



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




2079




 





 





 





 





 





 



        




2080




 





 





 





 





 





 



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




2081




 





 





 





 





 





 



     } 




2082




 





 





 





 





 





 



   ); 




2083




 





 





 





 





 





 



   




2084




 





 





 





 





 





 



 Iterate all table information from in database. 




2085




 





 





 





 





 





 



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




2086




 





 





 





 





 





 



 Callback receive three arguments, C, C, 




2087




 





 





 





 





 





 



 C. 




2088




 





 





 





 





 





 



   




2089




 





 





 





 





 





 



 If C is set, C method use C 




2090




 





 





 





 





 





 



 information, you can improve the performance of C in 




2091




 





 





 





 





 





 



 the following way. 




2092




 





 





 





 





 





 



   




2093




 





 





 





 





 





 



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




2094




 





 





 





 





 





 



   $dbi->user_table_info($table_info); 




2095




 





 





 





 





 





 



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




2096




 





 





 





 





 





 



   




2097




 





 





 





 





 





 



 =head2 execute 




2098




 





 





 





 





 





 



   




2099




 





 





 





 





 





 



   my $result = $dbi->execute( 




2100




 





 





 





 





 





 



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




2101




 





 





 





 





 





 



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




2102




 





 





 





 





 





 



   ); 




2103




 





 





 





 





 





 



   




2104




 





 





 





 





 





 



   my $result = $dbi->execute( 




2105




 





 





 





 





 





 



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




2106




 





 





 





 





 





 



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




2107




 





 





 





 





 





 



   ); 




2108




 





 





 





 





 





 



   




2109




 





 





 





 





 





 



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




2110




 





 





 





 





 





 



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




2111




 





 





 





 





 





 



 Second argument is data, embedded into column parameter. 




2112




 





 





 





 





 





 



 Return value is L object when select statement is executed, 




2113




 





 





 





 





 





 



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




2114




 





 





 





 





 





 



   




2115




 





 





 





 





 





 



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




2116




 





 





 





 





 





 



    




2117




 





 





 





 





 





 



   # Original 




2118




 





 





 





 





 





 



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




2119




 





 





 





 





 





 



    




2120




 





 





 





 





 





 



   # Replaced 




2121




 





 





 





 





 





 



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




2122




 





 





 





 





 





 



   




2123




 





 





 





 





 





 



 You can specify operator with named placeholder 




2124




 





 





 





 





 





 



 by C syntax. 




2125




 





 





 





 





 





 



   




2126




 





 





 





 





 





 



   # Original 




2127




 





 





 





 





 





 



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




2128




 





 





 





 





 





 



    




2129




 





 





 





 





 





 



   # Replaced 




2130




 





 





 





 





 





 



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




2131




 





 





 





 





 





 



   




2132




 





 





 





 





 





 



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




2133




 





 





 





 





 





 



 it is not parsed as named placeholder. 




2134




 





 





 





 





 





 



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




2135




 





 





 





 





 





 



   




2136




 





 





 





 





 





 



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




2137




 





 





 





 





 





 



   




2138




 





 





 





 





 





 



 B 




2139




 





 





 





 





 





 



   




2140




 





 





 





 





 





 



 The following options are available. 




2141




 





 





 





 





 





 



   




2142




 





 





 





 





 





 



 =over 4 




2143




 





 





 





 





 





 



   




2144




 





 





 





 





 





 



 =item after_build_sql  




2145




 





 





 





 





 





 



   




2146




 





 





 





 





 





 



 You can filter sql after the sql is build. 




2147




 





 





 





 





 





 



   




2148




 





 





 





 





 





 



   after_build_sql => $code_ref 




2149




 





 





 





 





 





 



   




2150




 





 





 





 





 





 



 The following one is one example. 




2151




 





 





 





 





 





 



   




2152




 





 





 





 





 





 



   $dbi->select( 




2153




 





 





 





 





 





 



     table => 'book', 




2154




 





 





 





 





 





 



     column => 'distinct(name)', 




2155




 





 





 





 





 





 



     after_build_sql => sub { 




2156




 





 





 





 





 





 



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




2157




 





 





 





 





 





 



     } 




2158




 





 





 





 





 





 



   ); 




2159




 





 





 





 





 





 



   




2160




 





 





 





 





 





 



 The following SQL is executed. 




2161




 





 





 





 





 





 



   




2162




 





 





 





 





 





 



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




2163




 





 





 





 





 





 



   




2164




 





 





 





 





 





 



 =item append 




2165




 





 





 





 





 





 



   




2166




 





 





 





 





 





 



   append => 'order by name' 




2167




 





 





 





 





 





 



   




2168




 





 





 





 





 





 



 Append some statement after SQL. 




2169




 





 





 





 





 





 



   




2170




 





 





 





 





 





 



 =item bind_type 




2171




 





 





 





 





 





 



   




2172




 





 





 





 





 





 



 Specify database bind data type. 




2173




 





 





 





 





 





 



    




2174




 





 





 





 





 





 



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




2175




 





 





 





 





 





 



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




2176




 





 





 





 





 





 



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




2177




 





 





 





 





 





 



   




2178




 





 





 





 





 





 



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




2179




 





 





 





 





 





 



   




2180




 





 





 





 





 





 



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




2181




 





 





 





 





 





 



   




2182




 





 





 





 





 





 



 =item filter 




2183




 





 





 





 





 





 



    




2184




 





 





 





 





 





 



   filter => { 




2185




 





 





 





 





 





 



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




2186




 





 





 





 





 





 



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




2187




 





 





 





 





 





 



   } 




2188




 





 





 





 





 





 



   




2189




 





 





 





 





 





 



   # Filter name 




2190




 





 





 





 





 





 



   filter => { 




2191




 





 





 





 





 





 



     title  => 'upper_case', 




2192




 





 





 





 





 





 



     author => 'upper_case' 




2193




 





 





 





 





 





 



   } 




2194




 





 





 





 





 





 



        




2195




 





 





 





 





 





 



   # At once 




2196




 





 





 





 





 





 



   filter => [ 




2197




 





 





 





 





 





 



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




2198




 





 





 





 





 





 



   ] 




2199




 





 





 





 





 





 



   




2200




 





 





 





 





 





 



 Filter. You can set subroutine or filter name 




2201




 





 





 





 





 





 



 registered by C. 




2202




 





 





 





 





 





 



 This filter is executed before data is saved into database. 




2203




 





 





 





 





 





 



 and before type rule filter is executed. 




2204




 





 





 





 





 





 



   




2205




 





 





 





 





 





 



 =item reuse 




2206




 





 





 





 





 





 



    




2207




 





 





 





 





 





 



   reuse => $hash_ref 




2208




 





 





 





 





 





 



   




2209




 





 





 





 





 





 



 Reuse statement handle in same SQL. 




2210




 





 





 





 





 





 



    




2211




 





 





 





 





 





 



   my $reuse = {}; 




2212




 





 





 





 





 





 



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




2213




 





 





 





 





 





 



   




2214




 





 





 





 





 





 



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




2215




 





 





 





 





 





 



   




2216




 





 





 





 





 





 



 =item table 




2217




 





 





 





 





 





 



    




2218




 





 





 





 





 





 



   table => 'author' 




2219




 





 





 





 





 





 



   




2220




 





 





 





 





 





 



 If you want to omit table name in column name 




2221




 





 





 





 





 





 



 and enable C and C type filter, 




2222




 





 





 





 





 





 



 You must set C option. 




2223




 





 





 





 





 





 



   




2224




 





 





 





 





 





 



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




2225




 





 





 





 





 





 



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




2226




 





 





 





 





 





 



   




2227




 





 





 





 





 





 



   # Same 




2228




 





 





 





 





 





 



   $dbi->execute( 




2229




 





 





 





 





 





 



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




2230




 





 





 





 





 





 



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




2231




 





 





 





 





 





 



   




2232




 





 





 





 





 





 



 =item table_alias 




2233




 





 





 





 





 





 



   




2234




 





 





 





 





 





 



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




2235




 





 





 





 





 





 



   




2236




 





 





 





 





 





 



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




2237




 





 





 





 





 





 



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




2238




 





 





 





 





 





 



 on alias table name. 




2239




 





 





 





 





 





 



   




2240




 





 





 





 





 





 



 =item type_rule_off 




2241




 





 





 





 





 





 



   




2242




 





 





 





 





 





 



   type_rule_off => 1 




2243




 





 





 





 





 





 



   




2244




 





 





 





 





 





 



 Turn C and C type rule off. 




2245




 





 





 





 





 





 



   




2246




 





 





 





 





 





 



 =item type_rule1_off 




2247




 





 





 





 





 





 



   




2248




 





 





 





 





 





 



   type_rule1_off => 1 




2249




 





 





 





 





 





 



   




2250




 





 





 





 





 





 



 Turn C type rule off. 




2251




 





 





 





 





 





 



   




2252




 





 





 





 





 





 



 =item type_rule2_off 




2253




 





 





 





 





 





 



   




2254




 





 





 





 





 





 



   type_rule2_off => 1 




2255




 





 





 





 





 





 



   




2256




 





 





 





 





 





 



 Turn C type rule off. 




2257




 





 





 





 





 





 



   




2258




 





 





 





 





 





 



 =head2 get_column_info 




2259




 





 





 





 





 





 



   




2260




 





 





 





 





 





 



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




2261




 





 





 





 





 





 



   




2262




 





 





 





 





 





 



 get column information except for one which match C pattern. 




2263




 





 





 





 





 





 



   




2264




 





 





 





 





 





 



   [ 




2265




 





 





 





 





 





 



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




2266




 





 





 





 





 





 



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




2267




 





 





 





 





 





 



   ] 




2268




 





 





 





 





 





 



   




2269




 





 





 





 





 





 



 =head2 get_table_info 




2270




 





 





 





 





 





 



   




2271




 





 





 





 





 





 



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




2272




 





 





 





 





 





 



   




2273




 





 





 





 





 





 



 get table information except for one which match C pattern. 




2274




 





 





 





 





 





 



   




2275




 





 





 





 





 





 



   [ 




2276




 





 





 





 





 





 



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




2277




 





 





 





 





 





 



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




2278




 





 





 





 





 





 



   ] 




2279




 





 





 





 





 





 



   




2280




 





 





 





 





 





 



 You can set this value to C. 




2281




 





 





 





 





 





 



   




2282




 





 





 





 





 





 



 =head2 insert 




2283




 





 





 





 





 





 



   




2284




 





 





 





 





 





 



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




2285




 





 





 





 





 





 



   




2286




 





 





 





 





 





 



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




2287




 





 





 





 





 





 



 affected row count. 




2288




 





 





 





 





 





 



   




2289




 





 





 





 





 





 



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




2290




 





 





 





 





 





 



 as parameter value. 




2291




 





 





 





 





 





 



   




2292




 





 





 





 





 





 



   {date => \"NOW()"} 




2293




 





 





 





 





 





 



   




2294




 





 





 





 





 





 



 You can pass multiple parameters, this is very fast. 




2295




 





 





 





 





 





 



   




2296




 





 





 





 





 





 



   $dbi->insert( 




2297




 





 





 





 





 





 



     [ 




2298




 





 





 





 





 





 



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




2299




 





 





 





 





 





 



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




2300




 





 





 





 





 





 



     ], 




2301




 





 





 





 





 





 



     table  => 'book' 




2302




 





 





 





 





 





 



   ); 




2303




 





 





 





 





 





 



   




2304




 





 





 





 





 





 



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




2305




 





 





 





 





 





 



 and only first parameter is used to create sql. 




2306




 





 





 





 





 





 



   




2307




 





 





 





 





 





 



 B 




2308




 





 





 





 





 





 



   




2309




 





 





 





 





 





 



 C method use all of C method's options, 




2310




 





 





 





 





 





 



 and use the following new ones. 




2311




 





 





 





 





 





 



   




2312




 





 





 





 





 





 



 =over 4 




2313




 





 





 





 





 





 



   




2314




 





 





 





 





 





 



 =item bulk_insert 




2315




 





 





 





 





 





 



   




2316




 





 





 





 





 





 



   bulk_insert => 1 




2317




 





 





 





 





 





 



   




2318




 





 





 





 





 





 



 bulk insert is executed if database support bulk insert and  




2319




 





 





 





 





 





 



 multiple parameters is passed to C. 




2320




 





 





 





 





 





 



 The SQL like the following one is executed. 




2321




 





 





 





 





 





 



   




2322




 





 





 





 





 





 



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




2323




 





 





 





 





 





 



   




2324




 





 





 





 





 





 



 =item ctime 




2325




 





 





 





 





 





 



   




2326




 





 





 





 





 





 



   ctime => 'created_time' 




2327




 





 





 





 





 





 



   




2328




 





 





 





 





 





 



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




2329




 





 





 





 





 





 



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




2330




 





 





 





 





 





 



 C attribute. 




2331




 





 





 





 





 





 



   




2332




 





 





 





 





 





 



 =item prefix 




2333




 





 





 





 





 





 



   




2334




 





 





 





 





 





 



   prefix => 'or replace' 




2335




 





 





 





 





 





 



   




2336




 





 





 





 





 





 



 prefix before table name section 




2337




 





 





 





 





 





 



   




2338




 





 





 





 





 





 



   insert or replace into book 




2339




 





 





 





 





 





 



   




2340




 





 





 





 





 





 



 =item table 




2341




 





 





 





 





 





 



   




2342




 





 





 





 





 





 



   table => 'book' 




2343




 





 





 





 





 





 



   




2344




 





 





 





 





 





 



 Table name. 




2345




 





 





 





 





 





 



   




2346




 





 





 





 





 





 



 =item mtime 




2347




 





 





 





 





 





 



   




2348




 





 





 





 





 





 



 This option is same as C method C option. 




2349




 





 





 





 





 





 



   




2350




 





 





 





 





 





 



 =item wrap 




2351




 





 





 





 





 





 



   




2352




 





 





 





 





 





 



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




2353




 





 





 





 





 





 



   




2354




 





 





 





 





 





 



 placeholder wrapped string. 




2355




 





 





 





 





 





 



   




2356




 





 





 





 





 





 



 If the following statement 




2357




 





 





 





 





 





 



   




2358




 





 





 





 





 





 



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




2359




 





 





 





 





 





 



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




2360




 





 





 





 





 





 



   




2361




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2362




 





 





 





 





 





 



   




2363




 





 





 





 





 





 



   insert into book price values ( ? + 5 ); 




2364




 





 





 





 





 





 



   




2365




 





 





 





 





 





 



 =back 




2366




 





 





 





 





 





 



   




2367




 





 





 





 





 





 



 =over 4 




2368




 





 





 





 





 





 



   




2369




 





 





 





 





 





 



 =head2 include_model 




2370




 





 





 





 





 





 



   




2371




 





 





 





 





 





 



   $dbi->include_model('MyModel'); 




2372




 





 





 





 





 





 



   




2373




 





 





 





 





 





 



 Include models from specified namespace, 




2374




 





 





 





 





 





 



 the following layout is needed to include models. 




2375




 





 





 





 





 





 



   




2376




 





 





 





 





 





 



   lib / MyModel.pm 




2377




 





 





 





 





 





 



       / MyModel / book.pm 




2378




 





 





 





 





 





 



                 / company.pm 




2379




 





 





 





 





 





 



   




2380




 





 





 





 





 





 



 Name space module, extending L. 




2381




 





 





 





 





 





 



   




2382




 





 





 





 





 





 



 B 




2383




 





 





 





 





 





 



   




2384




 





 





 





 





 





 



   package MyModel; 




2385




 





 





 





 





 





 



   use DBIx::Custom::Model -base; 




2386




 





 





 





 





 





 



    




2387




 





 





 





 





 





 



   1; 




2388




 





 





 





 





 





 



   




2389




 





 





 





 





 





 



 Model modules, extending name space module. 




2390




 





 





 





 





 





 



   




2391




 





 





 





 





 





 



 B 




2392




 





 





 





 





 





 



   




2393




 





 





 





 





 





 



   package MyModel::book; 




2394




 





 





 





 





 





 



   use MyModel -base; 




2395




 





 





 





 





 





 



    




2396




 





 





 





 





 





 



   1; 




2397




 





 





 





 





 





 



   




2398




 





 





 





 





 





 



 B 




2399




 





 





 





 





 





 



   




2400




 





 





 





 





 





 



   package MyModel::company; 




2401




 





 





 





 





 





 



   use MyModel -base; 




2402




 





 





 





 





 





 



    




2403




 





 





 





 





 





 



   1; 




2404




 





 





 





 





 





 



    




2405




 





 





 





 





 





 



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




2406




 





 





 





 





 





 



   




2407




 





 





 





 





 





 



 You can get model object by C. 




2408




 





 





 





 





 





 



   




2409




 





 





 





 





 





 



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




2410




 





 





 





 





 





 



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




2411




 





 





 





 





 





 



   




2412




 





 





 





 





 





 



 You can include full-qualified table name like C 




2413




 





 





 





 





 





 



   




2414




 





 





 





 





 





 



   lib / MyModel.pm 




2415




 





 





 





 





 





 



       / MyModel / main / book.pm 




2416




 





 





 





 





 





 



                        / company.pm 




2417




 





 





 





 





 





 



   




2418




 





 





 





 





 





 



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




2419




 





 





 





 





 





 



   




2420




 





 





 





 





 





 



 See L to know model features. 




2421




 





 





 





 





 





 



   




2422




 





 





 





 





 





 



 =head2 like_value 




2423




 





 





 





 





 





 



   




2424




 





 





 





 





 





 



   my $like_value = $dbi->like_value 




2425




 





 





 





 





 





 



   




2426




 





 





 





 





 





 



 Code reference which return a value for the like value. 




2427




 





 





 





 





 





 



   




2428




 





 





 





 





 





 



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




2429




 





 





 





 





 





 



   




2430




 





 





 





 





 





 



 =head2 mapper 




2431




 





 





 





 





 





 



   




2432




 





 





 





 





 





 



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




2433




 





 





 





 





 





 



   




2434




 





 





 





 





 





 



 Create a new L object. 




2435




 





 





 





 





 





 



   




2436




 





 





 





 





 





 



 =head2 merge_param 




2437




 





 





 





 





 





 



   




2438




 





 





 





 





 





 



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




2439




 





 





 





 





 





 



   




2440




 





 





 





 





 





 



 Merge parameters. The following new parameter is created. 




2441




 





 





 





 





 





 



   




2442




 





 





 





 





 





 



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




2443




 





 





 





 





 





 



   




2444




 





 





 





 





 





 



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




2445




 





 





 





 





 





 



   




2446




 





 





 





 





 





 



 =head2 model 




2447




 





 





 





 





 





 



   




2448




 





 





 





 





 





 



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




2449




 





 





 





 





 





 



   




2450




 





 





 





 





 





 



 Get a L object 




2451




 





 





 





 





 





 



 create by C or C 




2452




 





 





 





 





 





 



   




2453




 





 





 





 





 





 



 =head2 mycolumn 




2454




 





 





 





 





 





 



   




2455




 





 





 





 





 





 



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




2456




 





 





 





 





 





 



   




2457




 





 





 





 





 





 



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




2458




 





 





 





 





 





 



   




2459




 





 





 





 





 





 



   book.author as author, 




2460




 





 





 





 





 





 



   book.title as title 




2461




 





 





 





 





 





 



   




2462




 





 





 





 





 





 



 =head2 new 




2463




 





 





 





 





 





 



   




2464




 





 





 





 





 





 



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




2465




 





 





 





 





 





 



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




2466




 





 





 





 





 





 



     user => 'ken', 




2467




 





 





 





 





 





 



     password => '!LFKD%$&', 




2468




 





 





 





 





 





 



     option => {mysql_enable_utf8 => 1} 




2469




 





 





 





 





 





 



   ); 




2470




 





 





 





 





 





 



   




2471




 





 





 





 





 





 



 Create a new L object. 




2472




 





 





 





 





 





 



   




2473




 





 





 





 





 





 



 =head2 not_exists 




2474




 





 





 





 





 





 



   




2475




 





 





 





 





 





 



   my $not_exists = $dbi->not_exists; 




2476




 





 





 





 





 





 



   




2477




 





 





 





 





 





 



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




2478




 





 





 





 





 





 



 This is used in C of L . 




2479




 





 





 





 





 





 



   




2480




 





 





 





 





 





 



 =head2 order 




2481




 





 





 





 





 





 



   




2482




 





 





 





 





 





 



   my $order = $dbi->order; 




2483




 





 





 





 





 





 



   




2484




 





 





 





 





 





 



 Create a new L object. 




2485




 





 





 





 





 





 



   




2486




 





 





 





 





 





 



 =head2 q 




2487




 





 





 





 





 





 



   




2488




 





 





 





 





 





 



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




2489




 





 





 





 





 





 



   




2490




 





 





 





 





 





 



 Quote string by value of C. 




2491




 





 





 





 





 





 



   




2492




 





 





 





 





 





 



 =head2 register_filter 




2493




 





 





 





 





 





 



   




2494




 





 





 





 





 





 



   $dbi->register_filter( 




2495




 





 





 





 





 





 



     # Time::Piece object to database DATE format 




2496




 





 





 





 





 





 



     tp_to_date => sub { 




2497




 





 





 





 





 





 



       my $tp = shift; 




2498




 





 





 





 





 





 



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




2499




 





 





 





 





 





 



     }, 




2500




 





 





 





 





 





 



     # database DATE format to Time::Piece object 




2501




 





 





 





 





 





 



     date_to_tp => sub { 




2502




 





 





 





 





 





 



       my $date = shift; 




2503




 





 





 





 





 





 



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




2504




 





 





 





 





 





 



     } 




2505




 





 





 





 





 





 



   ); 




2506




 





 





 





 





 





 



    




2507




 





 





 





 





 





 



 Register filters, used by C option of many methods. 




2508




 





 





 





 





 





 



   




2509




 





 





 





 





 





 



 =head2 select 




2510




 





 





 





 





 





 



   




2511




 





 





 





 





 





 



   my $result = $dbi->select( 




2512




 





 





 





 





 





 



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




2513




 





 





 





 





 





 



     table  => 'book', 




2514




 





 





 





 





 





 



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




2515




 





 





 





 





 





 



   ); 




2516




 





 





 





 





 





 



    




2517




 





 





 





 





 





 



 Execute select statement. 




2518




 





 





 





 





 





 



   




2519




 





 





 





 





 





 



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




2520




 





 





 





 





 





 



   




2521




 





 





 





 





 





 



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




2522




 





 





 





 





 





 



   




2523




 





 





 





 





 





 



 B 




2524




 





 





 





 





 





 



   




2525




 





 





 





 





 





 



 C method use all of C method's options, 




2526




 





 





 





 





 





 



 and use the following new ones. 




2527




 





 





 





 





 





 



   




2528




 





 





 





 





 





 



 =over 4 




2529




 





 





 





 





 





 



   




2530




 





 





 





 





 





 



 =item column 




2531




 





 





 





 





 





 



    




2532




 





 





 





 





 





 



   column => 'author' 




2533




 





 





 





 





 





 



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




2534




 





 





 





 





 





 



   




2535




 





 





 





 





 





 



 Column clause. 




2536




 





 





 





 





 





 



    




2537




 





 





 





 





 





 



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




2538




 





 





 





 





 





 



   




2539




 





 





 





 





 





 



   column => '*' 




2540




 





 





 





 





 





 



   




2541




 





 





 





 





 





 



 You can specify hash of array reference. 




2542




 





 





 





 





 





 



   




2543




 





 





 





 





 





 



   column => [ 




2544




 





 





 





 





 





 



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




2545




 





 





 





 





 





 



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




2546




 





 





 





 





 





 



   ] 




2547




 





 





 





 





 





 



   




2548




 





 





 





 





 





 



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




2549




 





 





 





 





 





 



   




2550




 





 





 





 





 





 



   book.author as "book.author", 




2551




 





 





 





 





 





 



   book.title as "book.title", 




2552




 





 





 





 





 





 



   person.name as "person.name", 




2553




 





 





 





 





 





 



   person.age as "person.age" 




2554




 





 





 





 





 





 



   




2555




 





 





 





 





 





 



 You can specify own column by C<__MY__>. 




2556




 





 





 





 





 





 



   




2557




 





 





 





 





 





 



   column => [ 




2558




 





 





 





 





 





 



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




2559




 





 





 





 





 





 



   ] 




2560




 





 





 





 





 





 



   




2561




 





 





 





 





 





 



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




2562




 





 





 





 





 





 



   




2563




 





 





 





 





 





 



   book.author as "author", 




2564




 





 





 





 





 





 



   book.title as "title", 




2565




 





 





 





 





 





 



   




2566




 





 





 





 





 





 



 C<__MY__> can be changed by C attribute. 




2567




 





 





 





 





 





 



   




2568




 





 





 





 





 





 



 =item param 




2569




 





 





 





 





 





 



   




2570




 





 





 





 





 





 



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




2571




 





 





 





 





 





 



   




2572




 





 





 





 





 





 



 Parameter shown before where clause. 




2573




 





 





 





 





 





 



    




2574




 





 





 





 





 





 



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




2575




 





 





 





 





 





 



 you can pass parameter by C option. 




2576




 





 





 





 





 





 



   




2577




 





 





 





 





 





 



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




2578




 





 





 





 





 





 



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




2579




 





 





 





 





 





 



   




2580




 





 





 





 





 





 



 =item prefix 




2581




 





 





 





 





 





 



   




2582




 





 





 





 





 





 



   prefix => 'SQL_CALC_FOUND_ROWS' 




2583




 





 





 





 





 





 



   




2584




 





 





 





 





 





 



 Prefix of column clause 




2585




 





 





 





 





 





 



   




2586




 





 





 





 





 





 



   select SQL_CALC_FOUND_ROWS title, author from book; 




2587




 





 





 





 





 





 



   




2588




 





 





 





 





 





 



 =item join 




2589




 





 





 





 





 





 



   




2590




 





 





 





 





 





 



   join => [ 




2591




 





 





 





 





 





 



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




2592




 





 





 





 





 





 



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




2593




 





 





 





 





 





 



   ] 




2594




 





 





 





 





 





 



        




2595




 





 





 





 





 





 



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




2596




 





 





 





 





 





 



 join clauses needed when SQL is created is used automatically. 




2597




 





 





 





 





 





 



   




2598




 





 





 





 





 





 



   $dbi->select( 




2599




 





 





 





 





 





 



     table => 'book', 




2600




 





 





 





 





 





 



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




2601




 





 





 





 





 





 



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




2602




 





 





 





 





 





 



     join => [ 




2603




 





 





 





 





 





 



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




2604




 





 





 





 





 





 



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




2605




 





 





 





 





 





 



     ] 




2606




 





 





 





 





 





 



   ); 




2607




 





 





 





 





 





 



   




2608




 





 





 





 





 





 



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




2609




 





 





 





 





 





 



 the following SQL is created 




2610




 





 





 





 





 





 



   




2611




 





 





 





 





 





 



   select company.location_id as location_id 




2612




 





 





 





 





 





 



   from book 




2613




 





 





 





 





 





 



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




2614




 





 





 





 





 





 



   where company.name = ?; 




2615




 





 





 





 





 





 



   




2616




 





 





 





 





 





 



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




2617




 





 





 





 





 





 



 the join clause correctly. 




2618




 





 





 





 





 





 



   




2619




 





 





 





 





 





 



   $dbi->select( 




2620




 





 





 





 





 





 



     table => 'book', 




2621




 





 





 





 





 





 



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




2622




 





 





 





 





 





 



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




2623




 





 





 





 





 





 



     join => [ 




2624




 





 





 





 





 





 



       { 




2625




 





 





 





 





 





 



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




2626




 





 





 





 





 





 



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




2627




 





 





 





 





 





 



       } 




2628




 





 





 





 





 





 



     ] 




2629




 





 





 





 





 





 



   ); 




2630




 





 





 





 





 





 



   




2631




 





 





 





 





 





 



 =item table 




2632




 





 





 





 





 





 



   




2633




 





 





 





 





 





 



   table => 'book' 




2634




 





 





 





 





 





 



   




2635




 





 





 





 





 





 



 Table name. 




2636




 





 





 





 





 





 



   




2637




 





 





 





 





 





 



 =item where 




2638




 





 





 





 





 





 



    




2639




 





 





 





 





 





 



   # (1) Hash reference 




2640




 





 





 





 





 





 



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




2641




 





 





 





 





 





 



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




2642




 





 





 





 





 





 



    




2643




 





 





 





 





 





 



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




2644




 





 





 





 





 





 



   where => $dbi->where( 




2645




 





 





 





 





 





 



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




2646




 





 





 





 





 





 



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




2647




 





 





 





 





 





 



   ) 




2648




 





 





 





 





 





 



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




2649




 





 





 





 





 





 



    




2650




 





 





 





 





 





 



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




2651




 





 





 





 





 





 



   where => [ 




2652




 





 





 





 





 





 



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




2653




 





 





 





 





 





 



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




2654




 





 





 





 





 





 



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




2655




 





 





 





 





 





 



   ] 




2656




 





 





 





 





 





 



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




2657




 





 





 





 





 





 



    




2658




 





 





 





 





 





 



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




2659




 





 





 





 





 





 



   where => [ 




2660




 





 





 





 





 





 



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




2661




 





 





 





 





 





 



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




2662




 





 





 





 





 





 



   ] 




2663




 





 





 





 





 





 



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




2664




 





 





 





 





 





 



    




2665




 





 





 





 





 





 



   # (5) String 




2666




 





 





 





 





 





 



   where => 'title is null' 




2667




 





 





 





 





 





 



   #  -> where title is null 




2668




 





 





 





 





 





 



   




2669




 





 





 





 





 





 



 Where clause. 




2670




 





 





 





 





 





 



 See also L to know how to create where clause. 




2671




 





 





 





 





 





 



    




2672




 





 





 





 





 





 



 =back 




2673




 





 





 





 





 





 



   




2674




 





 





 





 





 





 



 =head2 type_rule 




2675




 





 





 





 





 





 



   




2676




 





 





 





 





 





 



   $dbi->type_rule( 




2677




 





 





 





 





 





 



     into1 => { 




2678




 





 





 





 





 





 



       date => sub { ... }, 




2679




 





 





 





 





 





 



       datetime => sub { ... } 




2680




 





 





 





 





 





 



     }, 




2681




 





 





 





 





 





 



     into2 => { 




2682




 





 





 





 





 





 



       date => sub { ... }, 




2683




 





 





 





 





 





 



       datetime => sub { ... } 




2684




 





 





 





 





 





 



     }, 




2685




 





 





 





 





 





 



     from1 => { 




2686




 





 





 





 





 





 



       # DATE 




2687




 





 





 





 





 





 



       9 => sub { ... }, 




2688




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2689




 





 





 





 





 





 



       11 => sub { ... }, 




2690




 





 





 





 





 





 



     } 




2691




 





 





 





 





 





 



     from2 => { 




2692




 





 





 





 





 





 



       # DATE 




2693




 





 





 





 





 





 



       9 => sub { ... }, 




2694




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2695




 





 





 





 





 





 



       11 => sub { ... }, 




2696




 





 





 





 





 





 



     } 




2697




 





 





 





 





 





 



   ); 




2698




 





 





 





 





 





 



   




2699




 





 





 





 





 





 



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




2700




 





 





 





 





 





 



 This has a little complex problem. 




2701




 





 





 





 





 





 



   




2702




 





 





 





 





 





 



 In C and C you can specify 




2703




 





 





 





 





 





 



 type name as same as type name defined 




2704




 





 





 





 





 





 



 by create table, such as C or C. 




2705




 





 





 





 





 





 



   




2706




 





 





 





 





 





 



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




2707




 





 





 





 





 





 



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




2708




 





 





 





 





 





 



   




2709




 





 





 





 





 





 



 C is executed after C. 




2710




 





 





 





 





 





 



   




2711




 





 





 





 





 





 



 Type rule of C and C is enabled on the following 




2712




 





 





 





 





 





 



 column name. 




2713




 





 





 





 





 





 



   




2714




 





 





 





 





 





 



 =over 4 




2715




 





 





 





 





 





 



   




2716




 





 





 





 





 





 



 =item 1. column name 




2717




 





 





 





 





 





 



   




2718




 





 





 





 





 





 



   issue_date 




2719




 





 





 





 





 





 



   issue_datetime 




2720




 





 





 





 





 





 



   




2721




 





 





 





 





 





 



 This need C option in each method. 




2722




 





 





 





 





 





 



   




2723




 





 





 





 





 





 



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




2724




 





 





 





 





 





 



   




2725




 





 





 





 





 





 



   book.issue_date 




2726




 





 





 





 





 





 



   book.issue_datetime 




2727




 





 





 





 





 





 



   




2728




 





 





 





 





 





 



 =back 




2729




 





 





 





 





 





 



   




2730




 





 





 





 





 





 



 You get all type name used in database by C. 




2731




 





 





 





 





 





 



   




2732




 





 





 





 





 





 



   print $dbi->available_typename; 




2733




 





 





 





 





 





 



   




2734




 





 





 





 





 





 



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




2735




 





 





 





 





 





 



 C is executed after C. 




2736




 





 





 





 





 





 



 You get all data type by C. 




2737




 





 





 





 





 





 



   




2738




 





 





 





 





 





 



   print $dbi->available_datatype; 




2739




 





 





 





 





 





 



   




2740




 





 





 





 





 





 



 You can also specify multiple types at once. 




2741




 





 





 





 





 





 



   




2742




 





 





 





 





 





 



   $dbi->type_rule( 




2743




 





 





 





 





 





 



     into1 => [ 




2744




 





 





 





 





 





 



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




2745




 





 





 





 





 





 



     ], 




2746




 





 





 





 





 





 



   ); 




2747




 





 





 





 





 





 



   




2748




 





 





 





 





 





 



 =head2 update 




2749




 





 





 





 





 





 



   




2750




 





 





 





 





 





 



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




2751




 





 





 





 





 





 



   




2752




 





 





 





 





 





 



 Execute update statement. First argument is update row data. 




2753




 





 





 





 





 





 



   




2754




 





 





 





 





 





 



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




2755




 





 





 





 





 





 



 as parameter value. 




2756




 





 





 





 





 





 



   




2757




 





 





 





 





 





 



   {date => \"NOW()"} 




2758




 





 





 





 





 





 



   




2759




 





 





 





 





 





 



 B 




2760




 





 





 





 





 





 



   




2761




 





 





 





 





 





 



 C method use all of C method's options, 




2762




 





 





 





 





 





 



 and use the following new ones. 




2763




 





 





 





 





 





 



   




2764




 





 





 





 





 





 



 =over 4 




2765




 





 





 





 





 





 



   




2766




 





 





 





 





 





 



 =item prefix 




2767




 





 





 





 





 





 



   




2768




 





 





 





 





 





 



   prefix => 'or replace' 




2769




 





 





 





 





 





 



   




2770




 





 





 





 





 





 



 prefix before table name section 




2771




 





 





 





 





 





 



   




2772




 





 





 





 





 





 



   update or replace book 




2773




 





 





 





 





 





 



   




2774




 





 





 





 





 





 



 =item table 




2775




 





 





 





 





 





 



   




2776




 





 





 





 





 





 



   table => 'book' 




2777




 





 





 





 





 





 



   




2778




 





 





 





 





 





 



 Table name. 




2779




 





 





 





 





 





 



   




2780




 





 





 





 





 





 



 =item where 




2781




 





 





 





 





 





 



   




2782




 





 





 





 





 





 



 Same as C method's C option. 




2783




 





 





 





 





 





 



   




2784




 





 





 





 





 





 



 =item wrap 




2785




 





 





 





 





 





 



   




2786




 





 





 





 





 





 



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




2787




 





 





 





 





 





 



   




2788




 





 





 





 





 





 



 placeholder wrapped string. 




2789




 





 





 





 





 





 



   




2790




 





 





 





 





 





 



 If the following statement 




2791




 





 





 





 





 





 



   




2792




 





 





 





 





 





 



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




2793




 





 





 





 





 





 



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




2794




 





 





 





 





 





 



   




2795




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2796




 





 





 





 





 





 



   




2797




 





 





 





 





 





 



   update book set price =  ? + 5; 




2798




 





 





 





 





 





 



   




2799




 





 





 





 





 





 



 =item mtime 




2800




 





 





 





 





 





 



   




2801




 





 





 





 





 





 



   mtime => 'modified_time' 




2802




 





 





 





 





 





 



   




2803




 





 





 





 





 





 



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




2804




 





 





 





 





 





 



 default time format is C, which can be changed by 




2805




 





 





 





 





 





 



 C attribute. 




2806




 





 





 





 





 





 



   




2807




 





 





 





 





 





 



 =back 




2808




 





 





 





 





 





 



   




2809




 





 





 





 





 





 



 =head2 update_all 




2810




 





 





 





 





 





 



   




2811




 





 





 





 





 





 



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




2812




 





 





 





 





 





 



   




2813




 





 





 





 





 





 



 Execute update statement for all rows. 




2814




 





 





 





 





 





 



 Options is same as C method. 




2815




 





 





 





 





 





 



   




2816




 





 





 





 





 





 



 =over 4 




2817




 





 





 





 





 





 



   




2818




 





 





 





 





 





 



 =item option 




2819




 





 





 





 





 





 



   




2820




 





 





 





 





 





 



   option => { 




2821




 





 





 





 





 





 



     select => { 




2822




 





 





 





 





 





 



       append => '...' 




2823




 





 





 





 





 





 



     }, 




2824




 





 





 





 





 





 



     insert => { 




2825




 





 





 





 





 





 



       prefix => '...' 




2826




 





 





 





 





 





 



     }, 




2827




 





 





 





 





 





 



     update => { 




2828




 





 





 





 





 





 



       filter => {} 




2829




 





 





 





 





 





 



     } 




2830




 





 





 





 





 





 



   } 




2831




 





 





 





 





 





 



   




2832




 





 





 





 





 





 



 If you want to pass option to each method, 




2833




 





 





 





 





 





 



 you can use C option. 




2834




 





 





 





 





 





 



   




2835




 





 





 





 





 





 



 =over 4 




2836




 





 





 





 





 





 



   




2837




 





 





 





 





 





 



 =item select_option 




2838




 





 





 





 





 





 



   




2839




 





 





 





 





 





 



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




2840




 





 





 





 





 





 



   




2841




 





 





 





 





 





 



 select method option, 




2842




 





 





 





 





 





 



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




2843




 





 





 





 





 





 



   




2844




 





 





 





 





 





 



 =head2 show_datatype 




2845




 





 





 





 





 





 



   




2846




 





 





 





 





 





 



   $dbi->show_datatype($table); 




2847




 





 





 





 





 





 



   




2848




 





 





 





 





 





 



 Show data type of the columns of specified table. 




2849




 





 





 





 





 





 



   




2850




 





 





 





 





 





 



   book 




2851




 





 





 





 





 





 



   title: 5 




2852




 





 





 





 





 





 



   issue_date: 91 




2853




 





 





 





 





 





 



   




2854




 





 





 





 





 





 



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




2855




 





 





 





 





 





 



   




2856




 





 





 





 





 





 



 =head2 show_tables 




2857




 





 





 





 





 





 



   




2858




 





 





 





 





 





 



   $dbi->show_tables; 




2859




 





 





 





 





 





 



   




2860




 





 





 





 





 





 



 Show tables. 




2861




 





 





 





 





 





 



   




2862




 





 





 





 





 





 



 =head2 show_typename 




2863




 





 





 





 





 





 



   




2864




 





 





 





 





 





 



   $dbi->show_typename($table); 




2865




 





 





 





 





 





 



   




2866




 





 





 





 





 





 



 Show type name of the columns of specified table. 




2867




 





 





 





 





 





 



   




2868




 





 





 





 





 





 



   book 




2869




 





 





 





 





 





 



   title: varchar 




2870




 





 





 





 





 





 



   issue_date: date 




2871




 





 





 





 





 





 



   




2872




 





 





 





 





 





 



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




2873




 





 





 





 





 





 



   




2874




 





 





 





 





 





 



 =head2 values_clause 




2875




 





 





 





 





 





 



   




2876




 





 





 





 





 





 



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




2877




 





 





 





 





 





 



   




2878




 





 





 





 





 





 



 Create values clause. 




2879




 





 





 





 





 





 



   




2880




 





 





 





 





 





 



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




2881




 





 





 





 





 





 



   




2882




 





 





 





 





 





 



 You can use this in insert statement. 




2883




 





 





 





 





 





 



   




2884




 





 





 





 





 





 



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




2885




 





 





 





 





 





 



   




2886




 





 





 





 





 





 



 =head2 where 




2887




 





 





 





 





 





 



   




2888




 





 





 





 





 





 



   my $where = $dbi->where; 




2889




 





 





 





 





 





 



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




2890




 





 





 





 





 





 



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




2891




 





 





 





 





 





 



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




2892




 





 





 





 





 





 



   




2893




 





 





 





 





 





 



 Create a new L object. 




2894




 





 





 





 





 





 



 See L to know how to create where clause. 




2895




 





 





 





 





 





 



   




2896




 





 





 





 





 





 



 =head1 ENVIRONMENTAL VARIABLES 




2897




 





 





 





 





 





 



   




2898




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG 




2899




 





 





 





 





 





 



   




2900




 





 





 





 





 





 



 If environment variable C is set to true, 




2901




 





 





 





 





 





 



 executed SQL and bind values are printed to STDERR. 




2902




 





 





 





 





 





 



   




2903




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG_ENCODING 




2904




 





 





 





 





 





 



   




2905




 





 





 





 





 





 



 DEBUG output encoding. Default to UTF-8. 




2906




 





 





 





 





 





 



   




2907




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION 




2908




 





 





 





 





 





 



   




2909




 





 





 





 





 





 



   $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25'; 




2910




 





 





 





 





 





 



   




2911




 





 





 





 





 





 



 Suppress deprecation warnings before specified version. 




2912




 





 





 





 





 





 



   




2913




 





 





 





 





 





 



 =head1 DEPRECATED FUNCTIONALITY 




2914




 





 





 





 





 





 



   




2915




 





 





 





 





 





 



 L 




2916




 





 





 





 





 





 



   




2917




 





 





 





 





 





 



   # Methods 




2918




 





 





 





 





 





 



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




2919




 





 





 





 





 





 



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




2920




 





 





 





 





 





 



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




2921




 





 





 





 





 





 



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




2922




 





 





 





 





 





 



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




2923




 





 





 





 





 





 



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




2924




 





 





 





 





 





 



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




2925




 





 





 





 





 





 



   




2926




 





 





 





 





 





 



 L 




2927




 





 





 





 





 





 



    




2928




 





 





 





 





 





 



   # Options 




2929




 





 





 





 





 





 



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




2930




 





 





 





 





 





 



   




2931




 





 





 





 





 





 



 L 




2932




 





 





 





 





 





 



   




2933




 





 





 





 





 





 



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




2934




 





 





 





 





 





 



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




2935




 





 





 





 





 





 



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




2936




 





 





 





 





 





 



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




2937




 





 





 





 





 





 



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




2938




 





 





 





 





 





 



   




2939




 





 





 





 





 





 



 =head1 BACKWARDS COMPATIBILITY POLICY 




2940




 





 





 





 





 





 



   




2941




 





 





 





 





 





 



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




2942




 





 





 





 





 





 



 DEPRECATED feature is removed after C, 




2943




 





 





 





 





 





 



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




2944




 





 





 





 





 





 



 I extend one year each time he tell me it. 




2945




 





 





 





 





 





 



   




2946




 





 





 





 





 





 



 DEPRECATION warnings can be suppressed by C 




2947




 





 





 





 





 





 



 environment variable. 




2948




 





 





 





 





 





 



   




2949




 





 





 





 





 





 



 EXPERIMENTAL features will be changed or deleted without warnings. 




2950




 





 





 





 





 





 



   




2951




 





 





 





 





 





 



 =head1 BUGS 




2952




 





 





 





 





 





 



   




2953




 





 





 





 





 





 



 Please tell me bugs if you find bug. 




2954




 





 





 





 





 





 



   




2955




 





 





 





 





 





 



 C<<  >> 




2956




 





 





 





 





 





 



   




2957




 





 





 





 





 





 



 L 




2958




 





 





 





 





 





 



   




2959




 





 





 





 





 





 



 =head1 AUTHOR 




2960




 





 





 





 





 





 



   




2961




 





 





 





 





 





 



 Yuki Kimoto, C<<  >> 




2962




 





 





 





 





 





 



   




2963




 





 





 





 





 





 



 =head1 COPYRIGHT & LICENSE 




2964




 





 





 





 





 





 



   




2965




 





 





 





 





 





 



 Copyright 2009-2019 Yuki Kimoto, all rights reserved. 




2966




 





 





 





 





 





 



   




2967




 





 





 





 





 





 



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




2968




 





 





 





 





 





 



 under the same terms as Perl itself. 




2969




 





 





 





 





 





 



   




2970




 





 





 





 





 





 



 =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, 




2087




 





 





 





 





 





 



 C. 




2088




 





 





 





 





 





 



   




2089




 





 





 





 





 





 



 If C is set, C method use C 




2090




 





 





 





 





 





 



 information, you can improve the performance of C in 




2091




 





 





 





 





 





 



 the following way. 




2092




 





 





 





 





 





 



   




2093




 





 





 





 





 





 



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




2094




 





 





 





 





 





 



   $dbi->user_table_info($table_info); 




2095




 





 





 





 





 





 



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




2096




 





 





 





 





 





 



   




2097




 





 





 





 





 





 



 =head2 execute 




2098




 





 





 





 





 





 



   




2099




 





 





 





 





 





 



   my $result = $dbi->execute( 




2100




 





 





 





 





 





 



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




2101




 





 





 





 





 





 



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




2102




 





 





 





 





 





 



   ); 




2103




 





 





 





 





 





 



   




2104




 





 





 





 





 





 



   my $result = $dbi->execute( 




2105




 





 





 





 





 





 



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




2106




 





 





 





 





 





 



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




2107




 





 





 





 





 





 



   ); 




2108




 





 





 





 





 





 



   




2109




 





 





 





 





 





 



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




2110




 





 





 





 





 





 



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




2111




 





 





 





 





 





 



 Second argument is data, embedded into column parameter. 




2112




 





 





 





 





 





 



 Return value is L object when select statement is executed, 




2113




 





 





 





 





 





 



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




2114




 





 





 





 





 





 



   




2115




 





 





 





 





 





 



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




2116




 





 





 





 





 





 



    




2117




 





 





 





 





 





 



   # Original 




2118




 





 





 





 





 





 



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




2119




 





 





 





 





 





 



    




2120




 





 





 





 





 





 



   # Replaced 




2121




 





 





 





 





 





 



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




2122




 





 





 





 





 





 



   




2123




 





 





 





 





 





 



 You can specify operator with named placeholder 




2124




 





 





 





 





 





 



 by C syntax. 




2125




 





 





 





 





 





 



   




2126




 





 





 





 





 





 



   # Original 




2127




 





 





 





 





 





 



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




2128




 





 





 





 





 





 



    




2129




 





 





 





 





 





 



   # Replaced 




2130




 





 





 





 





 





 



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




2131




 





 





 





 





 





 



   




2132




 





 





 





 





 





 



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




2133




 





 





 





 





 





 



 it is not parsed as named placeholder. 




2134




 





 





 





 





 





 



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




2135




 





 





 





 





 





 



   




2136




 





 





 





 





 





 



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




2137




 





 





 





 





 





 



   




2138




 





 





 





 





 





 



 B 




2139




 





 





 





 





 





 



   




2140




 





 





 





 





 





 



 The following options are available. 




2141




 





 





 





 





 





 



   




2142




 





 





 





 





 





 



 =over 4 




2143




 





 





 





 





 





 



   




2144




 





 





 





 





 





 



 =item after_build_sql  




2145




 





 





 





 





 





 



   




2146




 





 





 





 





 





 



 You can filter sql after the sql is build. 




2147




 





 





 





 





 





 



   




2148




 





 





 





 





 





 



   after_build_sql => $code_ref 




2149




 





 





 





 





 





 



   




2150




 





 





 





 





 





 



 The following one is one example. 




2151




 





 





 





 





 





 



   




2152




 





 





 





 





 





 



   $dbi->select( 




2153




 





 





 





 





 





 



     table => 'book', 




2154




 





 





 





 





 





 



     column => 'distinct(name)', 




2155




 





 





 





 





 





 



     after_build_sql => sub { 




2156




 





 





 





 





 





 



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




2157




 





 





 





 





 





 



     } 




2158




 





 





 





 





 





 



   ); 




2159




 





 





 





 





 





 



   




2160




 





 





 





 





 





 



 The following SQL is executed. 




2161




 





 





 





 





 





 



   




2162




 





 





 





 





 





 



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




2163




 





 





 





 





 





 



   




2164




 





 





 





 





 





 



 =item append 




2165




 





 





 





 





 





 



   




2166




 





 





 





 





 





 



   append => 'order by name' 




2167




 





 





 





 





 





 



   




2168




 





 





 





 





 





 



 Append some statement after SQL. 




2169




 





 





 





 





 





 



   




2170




 





 





 





 





 





 



 =item bind_type 




2171




 





 





 





 





 





 



   




2172




 





 





 





 





 





 



 Specify database bind data type. 




2173




 





 





 





 





 





 



    




2174




 





 





 





 





 





 



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




2175




 





 





 





 





 





 



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




2176




 





 





 





 





 





 



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




2177




 





 





 





 





 





 



   




2178




 





 





 





 





 





 



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




2179




 





 





 





 





 





 



   




2180




 





 





 





 





 





 



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




2181




 





 





 





 





 





 



   




2182




 





 





 





 





 





 



 =item filter 




2183




 





 





 





 





 





 



    




2184




 





 





 





 





 





 



   filter => { 




2185




 





 





 





 





 





 



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




2186




 





 





 





 





 





 



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




2187




 





 





 





 





 





 



   } 




2188




 





 





 





 





 





 



   




2189




 





 





 





 





 





 



   # Filter name 




2190




 





 





 





 





 





 



   filter => { 




2191




 





 





 





 





 





 



     title  => 'upper_case', 




2192




 





 





 





 





 





 



     author => 'upper_case' 




2193




 





 





 





 





 





 



   } 




2194




 





 





 





 





 





 



        




2195




 





 





 





 





 





 



   # At once 




2196




 





 





 





 





 





 



   filter => [ 




2197




 





 





 





 





 





 



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




2198




 





 





 





 





 





 



   ] 




2199




 





 





 





 





 





 



   




2200




 





 





 





 





 





 



 Filter. You can set subroutine or filter name 




2201




 





 





 





 





 





 



 registered by C. 




2202




 





 





 





 





 





 



 This filter is executed before data is saved into database. 




2203




 





 





 





 





 





 



 and before type rule filter is executed. 




2204




 





 





 





 





 





 



   




2205




 





 





 





 





 





 



 =item reuse 




2206




 





 





 





 





 





 



    




2207




 





 





 





 





 





 



   reuse => $hash_ref 




2208




 





 





 





 





 





 



   




2209




 





 





 





 





 





 



 Reuse statement handle in same SQL. 




2210




 





 





 





 





 





 



    




2211




 





 





 





 





 





 



   my $reuse = {}; 




2212




 





 





 





 





 





 



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




2213




 





 





 





 





 





 



   




2214




 





 





 





 





 





 



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




2215




 





 





 





 





 





 



   




2216




 





 





 





 





 





 



 =item table 




2217




 





 





 





 





 





 



    




2218




 





 





 





 





 





 



   table => 'author' 




2219




 





 





 





 





 





 



   




2220




 





 





 





 





 





 



 If you want to omit table name in column name 




2221




 





 





 





 





 





 



 and enable C and C type filter, 




2222




 





 





 





 





 





 



 You must set C option. 




2223




 





 





 





 





 





 



   




2224




 





 





 





 





 





 



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




2225




 





 





 





 





 





 



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




2226




 





 





 





 





 





 



   




2227




 





 





 





 





 





 



   # Same 




2228




 





 





 





 





 





 



   $dbi->execute( 




2229




 





 





 





 





 





 



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




2230




 





 





 





 





 





 



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




2231




 





 





 





 





 





 



   




2232




 





 





 





 





 





 



 =item table_alias 




2233




 





 





 





 





 





 



   




2234




 





 





 





 





 





 



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




2235




 





 





 





 





 





 



   




2236




 





 





 





 





 





 



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




2237




 





 





 





 





 





 



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




2238




 





 





 





 





 





 



 on alias table name. 




2239




 





 





 





 





 





 



   




2240




 





 





 





 





 





 



 =item type_rule_off 




2241




 





 





 





 





 





 



   




2242




 





 





 





 





 





 



   type_rule_off => 1 




2243




 





 





 





 





 





 



   




2244




 





 





 





 





 





 



 Turn C and C type rule off. 




2245




 





 





 





 





 





 



   




2246




 





 





 





 





 





 



 =item type_rule1_off 




2247




 





 





 





 





 





 



   




2248




 





 





 





 





 





 



   type_rule1_off => 1 




2249




 





 





 





 





 





 



   




2250




 





 





 





 





 





 



 Turn C type rule off. 




2251




 





 





 





 





 





 



   




2252




 





 





 





 





 





 



 =item type_rule2_off 




2253




 





 





 





 





 





 



   




2254




 





 





 





 





 





 



   type_rule2_off => 1 




2255




 





 





 





 





 





 



   




2256




 





 





 





 





 





 



 Turn C type rule off. 




2257




 





 





 





 





 





 



   




2258




 





 





 





 





 





 



 =head2 get_column_info 




2259




 





 





 





 





 





 



   




2260




 





 





 





 





 





 



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




2261




 





 





 





 





 





 



   




2262




 





 





 





 





 





 



 get column information except for one which match C pattern. 




2263




 





 





 





 





 





 



   




2264




 





 





 





 





 





 



   [ 




2265




 





 





 





 





 





 



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




2266




 





 





 





 





 





 



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




2267




 





 





 





 





 





 



   ] 




2268




 





 





 





 





 





 



   




2269




 





 





 





 





 





 



 =head2 get_table_info 




2270




 





 





 





 





 





 



   




2271




 





 





 





 





 





 



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




2272




 





 





 





 





 





 



   




2273




 





 





 





 





 





 



 get table information except for one which match C pattern. 




2274




 





 





 





 





 





 



   




2275




 





 





 





 





 





 



   [ 




2276




 





 





 





 





 





 



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




2277




 





 





 





 





 





 



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




2278




 





 





 





 





 





 



   ] 




2279




 





 





 





 





 





 



   




2280




 





 





 





 





 





 



 You can set this value to C. 




2281




 





 





 





 





 





 



   




2282




 





 





 





 





 





 



 =head2 insert 




2283




 





 





 





 





 





 



   




2284




 





 





 





 





 





 



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




2285




 





 





 





 





 





 



   




2286




 





 





 





 





 





 



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




2287




 





 





 





 





 





 



 affected row count. 




2288




 





 





 





 





 





 



   




2289




 





 





 





 





 





 



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




2290




 





 





 





 





 





 



 as parameter value. 




2291




 





 





 





 





 





 



   




2292




 





 





 





 





 





 



   {date => \"NOW()"} 




2293




 





 





 





 





 





 



   




2294




 





 





 





 





 





 



 You can pass multiple parameters, this is very fast. 




2295




 





 





 





 





 





 



   




2296




 





 





 





 





 





 



   $dbi->insert( 




2297




 





 





 





 





 





 



     [ 




2298




 





 





 





 





 





 



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




2299




 





 





 





 





 





 



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




2300




 





 





 





 





 





 



     ], 




2301




 





 





 





 





 





 



     table  => 'book' 




2302




 





 





 





 





 





 



   ); 




2303




 





 





 





 





 





 



   




2304




 





 





 





 





 





 



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




2305




 





 





 





 





 





 



 and only first parameter is used to create sql. 




2306




 





 





 





 





 





 



   




2307




 





 





 





 





 





 



 B 




2308




 





 





 





 





 





 



   




2309




 





 





 





 





 





 



 C method use all of C method's options, 




2310




 





 





 





 





 





 



 and use the following new ones. 




2311




 





 





 





 





 





 



   




2312




 





 





 





 





 





 



 =over 4 




2313




 





 





 





 





 





 



   




2314




 





 





 





 





 





 



 =item bulk_insert 




2315




 





 





 





 





 





 



   




2316




 





 





 





 





 





 



   bulk_insert => 1 




2317




 





 





 





 





 





 



   




2318




 





 





 





 





 





 



 bulk insert is executed if database support bulk insert and  




2319




 





 





 





 





 





 



 multiple parameters is passed to C. 




2320




 





 





 





 





 





 



 The SQL like the following one is executed. 




2321




 





 





 





 





 





 



   




2322




 





 





 





 





 





 



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




2323




 





 





 





 





 





 



   




2324




 





 





 





 





 





 



 =item ctime 




2325




 





 





 





 





 





 



   




2326




 





 





 





 





 





 



   ctime => 'created_time' 




2327




 





 





 





 





 





 



   




2328




 





 





 





 





 





 



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




2329




 





 





 





 





 





 



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




2330




 





 





 





 





 





 



 C attribute. 




2331




 





 





 





 





 





 



   




2332




 





 





 





 





 





 



 =item prefix 




2333




 





 





 





 





 





 



   




2334




 





 





 





 





 





 



   prefix => 'or replace' 




2335




 





 





 





 





 





 



   




2336




 





 





 





 





 





 



 prefix before table name section 




2337




 





 





 





 





 





 



   




2338




 





 





 





 





 





 



   insert or replace into book 




2339




 





 





 





 





 





 



   




2340




 





 





 





 





 





 



 =item table 




2341




 





 





 





 





 





 



   




2342




 





 





 





 





 





 



   table => 'book' 




2343




 





 





 





 





 





 



   




2344




 





 





 





 





 





 



 Table name. 




2345




 





 





 





 





 





 



   




2346




 





 





 





 





 





 



 =item mtime 




2347




 





 





 





 





 





 



   




2348




 





 





 





 





 





 



 This option is same as C method C option. 




2349




 





 





 





 





 





 



   




2350




 





 





 





 





 





 



 =item wrap 




2351




 





 





 





 





 





 



   




2352




 





 





 





 





 





 



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




2353




 





 





 





 





 





 



   




2354




 





 





 





 





 





 



 placeholder wrapped string. 




2355




 





 





 





 





 





 



   




2356




 





 





 





 





 





 



 If the following statement 




2357




 





 





 





 





 





 



   




2358




 





 





 





 





 





 



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




2359




 





 





 





 





 





 



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




2360




 





 





 





 





 





 



   




2361




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2362




 





 





 





 





 





 



   




2363




 





 





 





 





 





 



   insert into book price values ( ? + 5 ); 




2364




 





 





 





 





 





 



   




2365




 





 





 





 





 





 



 =back 




2366




 





 





 





 





 





 



   




2367




 





 





 





 





 





 



 =over 4 




2368




 





 





 





 





 





 



   




2369




 





 





 





 





 





 



 =head2 include_model 




2370




 





 





 





 





 





 



   




2371




 





 





 





 





 





 



   $dbi->include_model('MyModel'); 




2372




 





 





 





 





 





 



   




2373




 





 





 





 





 





 



 Include models from specified namespace, 




2374




 





 





 





 





 





 



 the following layout is needed to include models. 




2375




 





 





 





 





 





 



   




2376




 





 





 





 





 





 



   lib / MyModel.pm 




2377




 





 





 





 





 





 



       / MyModel / book.pm 




2378




 





 





 





 





 





 



                 / company.pm 




2379




 





 





 





 





 





 



   




2380




 





 





 





 





 





 



 Name space module, extending L. 




2381




 





 





 





 





 





 



   




2382




 





 





 





 





 





 



 B 




2383




 





 





 





 





 





 



   




2384




 





 





 





 





 





 



   package MyModel; 




2385




 





 





 





 





 





 



   use DBIx::Custom::Model -base; 




2386




 





 





 





 





 





 



    




2387




 





 





 





 





 





 



   1; 




2388




 





 





 





 





 





 



   




2389




 





 





 





 





 





 



 Model modules, extending name space module. 




2390




 





 





 





 





 





 



   




2391




 





 





 





 





 





 



 B 




2392




 





 





 





 





 





 



   




2393




 





 





 





 





 





 



   package MyModel::book; 




2394




 





 





 





 





 





 



   use MyModel -base; 




2395




 





 





 





 





 





 



    




2396




 





 





 





 





 





 



   1; 




2397




 





 





 





 





 





 



   




2398




 





 





 





 





 





 



 B 




2399




 





 





 





 





 





 



   




2400




 





 





 





 





 





 



   package MyModel::company; 




2401




 





 





 





 





 





 



   use MyModel -base; 




2402




 





 





 





 





 





 



    




2403




 





 





 





 





 





 



   1; 




2404




 





 





 





 





 





 



    




2405




 





 





 





 





 





 



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




2406




 





 





 





 





 





 



   




2407




 





 





 





 





 





 



 You can get model object by C. 




2408




 





 





 





 





 





 



   




2409




 





 





 





 





 





 



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




2410




 





 





 





 





 





 



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




2411




 





 





 





 





 





 



   




2412




 





 





 





 





 





 



 You can include full-qualified table name like C 




2413




 





 





 





 





 





 



   




2414




 





 





 





 





 





 



   lib / MyModel.pm 




2415




 





 





 





 





 





 



       / MyModel / main / book.pm 




2416




 





 





 





 





 





 



                        / company.pm 




2417




 





 





 





 





 





 



   




2418




 





 





 





 





 





 



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




2419




 





 





 





 





 





 



   




2420




 





 





 





 





 





 



 See L to know model features. 




2421




 





 





 





 





 





 



   




2422




 





 





 





 





 





 



 =head2 like_value 




2423




 





 





 





 





 





 



   




2424




 





 





 





 





 





 



   my $like_value = $dbi->like_value 




2425




 





 





 





 





 





 



   




2426




 





 





 





 





 





 



 Code reference which return a value for the like value. 




2427




 





 





 





 





 





 



   




2428




 





 





 





 





 





 



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




2429




 





 





 





 





 





 



   




2430




 





 





 





 





 





 



 =head2 mapper 




2431




 





 





 





 





 





 



   




2432




 





 





 





 





 





 



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




2433




 





 





 





 





 





 



   




2434




 





 





 





 





 





 



 Create a new L object. 




2435




 





 





 





 





 





 



   




2436




 





 





 





 





 





 



 =head2 merge_param 




2437




 





 





 





 





 





 



   




2438




 





 





 





 





 





 



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




2439




 





 





 





 





 





 



   




2440




 





 





 





 





 





 



 Merge parameters. The following new parameter is created. 




2441




 





 





 





 





 





 



   




2442




 





 





 





 





 





 



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




2443




 





 





 





 





 





 



   




2444




 





 





 





 





 





 



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




2445




 





 





 





 





 





 



   




2446




 





 





 





 





 





 



 =head2 model 




2447




 





 





 





 





 





 



   




2448




 





 





 





 





 





 



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




2449




 





 





 





 





 





 



   




2450




 





 





 





 





 





 



 Get a L object 




2451




 





 





 





 





 





 



 create by C or C 




2452




 





 





 





 





 





 



   




2453




 





 





 





 





 





 



 =head2 mycolumn 




2454




 





 





 





 





 





 



   




2455




 





 





 





 





 





 



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




2456




 





 





 





 





 





 



   




2457




 





 





 





 





 





 



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




2458




 





 





 





 





 





 



   




2459




 





 





 





 





 





 



   book.author as author, 




2460




 





 





 





 





 





 



   book.title as title 




2461




 





 





 





 





 





 



   




2462




 





 





 





 





 





 



 =head2 new 




2463




 





 





 





 





 





 



   




2464




 





 





 





 





 





 



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




2465




 





 





 





 





 





 



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




2466




 





 





 





 





 





 



     user => 'ken', 




2467




 





 





 





 





 





 



     password => '!LFKD%$&', 




2468




 





 





 





 





 





 



     option => {mysql_enable_utf8 => 1} 




2469




 





 





 





 





 





 



   ); 




2470




 





 





 





 





 





 



   




2471




 





 





 





 





 





 



 Create a new L object. 




2472




 





 





 





 





 





 



   




2473




 





 





 





 





 





 



 =head2 not_exists 




2474




 





 





 





 





 





 



   




2475




 





 





 





 





 





 



   my $not_exists = $dbi->not_exists; 




2476




 





 





 





 





 





 



   




2477




 





 





 





 





 





 



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




2478




 





 





 





 





 





 



 This is used in C of L . 




2479




 





 





 





 





 





 



   




2480




 





 





 





 





 





 



 =head2 order 




2481




 





 





 





 





 





 



   




2482




 





 





 





 





 





 



   my $order = $dbi->order; 




2483




 





 





 





 





 





 



   




2484




 





 





 





 





 





 



 Create a new L object. 




2485




 





 





 





 





 





 



   




2486




 





 





 





 





 





 



 =head2 q 




2487




 





 





 





 





 





 



   




2488




 





 





 





 





 





 



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




2489




 





 





 





 





 





 



   




2490




 





 





 





 





 





 



 Quote string by value of C. 




2491




 





 





 





 





 





 



   




2492




 





 





 





 





 





 



 =head2 register_filter 




2493




 





 





 





 





 





 



   




2494




 





 





 





 





 





 



   $dbi->register_filter( 




2495




 





 





 





 





 





 



     # Time::Piece object to database DATE format 




2496




 





 





 





 





 





 



     tp_to_date => sub { 




2497




 





 





 





 





 





 



       my $tp = shift; 




2498




 





 





 





 





 





 



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




2499




 





 





 





 





 





 



     }, 




2500




 





 





 





 





 





 



     # database DATE format to Time::Piece object 




2501




 





 





 





 





 





 



     date_to_tp => sub { 




2502




 





 





 





 





 





 



       my $date = shift; 




2503




 





 





 





 





 





 



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




2504




 





 





 





 





 





 



     } 




2505




 





 





 





 





 





 



   ); 




2506




 





 





 





 





 





 



    




2507




 





 





 





 





 





 



 Register filters, used by C option of many methods. 




2508




 





 





 





 





 





 



   




2509




 





 





 





 





 





 



 =head2 select 




2510




 





 





 





 





 





 



   




2511




 





 





 





 





 





 



   my $result = $dbi->select( 




2512




 





 





 





 





 





 



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




2513




 





 





 





 





 





 



     table  => 'book', 




2514




 





 





 





 





 





 



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




2515




 





 





 





 





 





 



   ); 




2516




 





 





 





 





 





 



    




2517




 





 





 





 





 





 



 Execute select statement. 




2518




 





 





 





 





 





 



   




2519




 





 





 





 





 





 



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




2520




 





 





 





 





 





 



   




2521




 





 





 





 





 





 



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




2522




 





 





 





 





 





 



   




2523




 





 





 





 





 





 



 B 




2524




 





 





 





 





 





 



   




2525




 





 





 





 





 





 



 C method use all of C method's options, 




2526




 





 





 





 





 





 



 and use the following new ones. 




2527




 





 





 





 





 





 



   




2528




 





 





 





 





 





 



 =over 4 




2529




 





 





 





 





 





 



   




2530




 





 





 





 





 





 



 =item column 




2531




 





 





 





 





 





 



    




2532




 





 





 





 





 





 



   column => 'author' 




2533




 





 





 





 





 





 



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




2534




 





 





 





 





 





 



   




2535




 





 





 





 





 





 



 Column clause. 




2536




 





 





 





 





 





 



    




2537




 





 





 





 





 





 



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




2538




 





 





 





 





 





 



   




2539




 





 





 





 





 





 



   column => '*' 




2540




 





 





 





 





 





 



   




2541




 





 





 





 





 





 



 You can specify hash of array reference. 




2542




 





 





 





 





 





 



   




2543




 





 





 





 





 





 



   column => [ 




2544




 





 





 





 





 





 



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




2545




 





 





 





 





 





 



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




2546




 





 





 





 





 





 



   ] 




2547




 





 





 





 





 





 



   




2548




 





 





 





 





 





 



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




2549




 





 





 





 





 





 



   




2550




 





 





 





 





 





 



   book.author as "book.author", 




2551




 





 





 





 





 





 



   book.title as "book.title", 




2552




 





 





 





 





 





 



   person.name as "person.name", 




2553




 





 





 





 





 





 



   person.age as "person.age" 




2554




 





 





 





 





 





 



   




2555




 





 





 





 





 





 



 You can specify own column by C<__MY__>. 




2556




 





 





 





 





 





 



   




2557




 





 





 





 





 





 



   column => [ 




2558




 





 





 





 





 





 



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




2559




 





 





 





 





 





 



   ] 




2560




 





 





 





 





 





 



   




2561




 





 





 





 





 





 



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




2562




 





 





 





 





 





 



   




2563




 





 





 





 





 





 



   book.author as "author", 




2564




 





 





 





 





 





 



   book.title as "title", 




2565




 





 





 





 





 





 



   




2566




 





 





 





 





 





 



 C<__MY__> can be changed by C attribute. 




2567




 





 





 





 





 





 



   




2568




 





 





 





 





 





 



 =item param 




2569




 





 





 





 





 





 



   




2570




 





 





 





 





 





 



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




2571




 





 





 





 





 





 



   




2572




 





 





 





 





 





 



 Parameter shown before where clause. 




2573




 





 





 





 





 





 



    




2574




 





 





 





 





 





 



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




2575




 





 





 





 





 





 



 you can pass parameter by C option. 




2576




 





 





 





 





 





 



   




2577




 





 





 





 





 





 



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




2578




 





 





 





 





 





 



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




2579




 





 





 





 





 





 



   




2580




 





 





 





 





 





 



 =item prefix 




2581




 





 





 





 





 





 



   




2582




 





 





 





 





 





 



   prefix => 'SQL_CALC_FOUND_ROWS' 




2583




 





 





 





 





 





 



   




2584




 





 





 





 





 





 



 Prefix of column clause 




2585




 





 





 





 





 





 



   




2586




 





 





 





 





 





 



   select SQL_CALC_FOUND_ROWS title, author from book; 




2587




 





 





 





 





 





 



   




2588




 





 





 





 





 





 



 =item join 




2589




 





 





 





 





 





 



   




2590




 





 





 





 





 





 



   join => [ 




2591




 





 





 





 





 





 



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




2592




 





 





 





 





 





 



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




2593




 





 





 





 





 





 



   ] 




2594




 





 





 





 





 





 



        




2595




 





 





 





 





 





 



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




2596




 





 





 





 





 





 



 join clauses needed when SQL is created is used automatically. 




2597




 





 





 





 





 





 



   




2598




 





 





 





 





 





 



   $dbi->select( 




2599




 





 





 





 





 





 



     table => 'book', 




2600




 





 





 





 





 





 



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




2601




 





 





 





 





 





 



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




2602




 





 





 





 





 





 



     join => [ 




2603




 





 





 





 





 





 



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




2604




 





 





 





 





 





 



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




2605




 





 





 





 





 





 



     ] 




2606




 





 





 





 





 





 



   ); 




2607




 





 





 





 





 





 



   




2608




 





 





 





 





 





 



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




2609




 





 





 





 





 





 



 the following SQL is created 




2610




 





 





 





 





 





 



   




2611




 





 





 





 





 





 



   select company.location_id as location_id 




2612




 





 





 





 





 





 



   from book 




2613




 





 





 





 





 





 



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




2614




 





 





 





 





 





 



   where company.name = ?; 




2615




 





 





 





 





 





 



   




2616




 





 





 





 





 





 



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




2617




 





 





 





 





 





 



 the join clause correctly. 




2618




 





 





 





 





 





 



   




2619




 





 





 





 





 





 



   $dbi->select( 




2620




 





 





 





 





 





 



     table => 'book', 




2621




 





 





 





 





 





 



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




2622




 





 





 





 





 





 



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




2623




 





 





 





 





 





 



     join => [ 




2624




 





 





 





 





 





 



       { 




2625




 





 





 





 





 





 



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




2626




 





 





 





 





 





 



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




2627




 





 





 





 





 





 



       } 




2628




 





 





 





 





 





 



     ] 




2629




 





 





 





 





 





 



   ); 




2630




 





 





 





 





 





 



   




2631




 





 





 





 





 





 



 =item table 




2632




 





 





 





 





 





 



   




2633




 





 





 





 





 





 



   table => 'book' 




2634




 





 





 





 





 





 



   




2635




 





 





 





 





 





 



 Table name. 




2636




 





 





 





 





 





 



   




2637




 





 





 





 





 





 



 =item where 




2638




 





 





 





 





 





 



    




2639




 





 





 





 





 





 



   # (1) Hash reference 




2640




 





 





 





 





 





 



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




2641




 





 





 





 





 





 



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




2642




 





 





 





 





 





 



    




2643




 





 





 





 





 





 



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




2644




 





 





 





 





 





 



   where => $dbi->where( 




2645




 





 





 





 





 





 



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




2646




 





 





 





 





 





 



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




2647




 





 





 





 





 





 



   ) 




2648




 





 





 





 





 





 



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




2649




 





 





 





 





 





 



    




2650




 





 





 





 





 





 



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




2651




 





 





 





 





 





 



   where => [ 




2652




 





 





 





 





 





 



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




2653




 





 





 





 





 





 



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




2654




 





 





 





 





 





 



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




2655




 





 





 





 





 





 



   ] 




2656




 





 





 





 





 





 



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




2657




 





 





 





 





 





 



    




2658




 





 





 





 





 





 



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




2659




 





 





 





 





 





 



   where => [ 




2660




 





 





 





 





 





 



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




2661




 





 





 





 





 





 



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




2662




 





 





 





 





 





 



   ] 




2663




 





 





 





 





 





 



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




2664




 





 





 





 





 





 



    




2665




 





 





 





 





 





 



   # (5) String 




2666




 





 





 





 





 





 



   where => 'title is null' 




2667




 





 





 





 





 





 



   #  -> where title is null 




2668




 





 





 





 





 





 



   




2669




 





 





 





 





 





 



 Where clause. 




2670




 





 





 





 





 





 



 See also L to know how to create where clause. 




2671




 





 





 





 





 





 



    




2672




 





 





 





 





 





 



 =back 




2673




 





 





 





 





 





 



   




2674




 





 





 





 





 





 



 =head2 type_rule 




2675




 





 





 





 





 





 



   




2676




 





 





 





 





 





 



   $dbi->type_rule( 




2677




 





 





 





 





 





 



     into1 => { 




2678




 





 





 





 





 





 



       date => sub { ... }, 




2679




 





 





 





 





 





 



       datetime => sub { ... } 




2680




 





 





 





 





 





 



     }, 




2681




 





 





 





 





 





 



     into2 => { 




2682




 





 





 





 





 





 



       date => sub { ... }, 




2683




 





 





 





 





 





 



       datetime => sub { ... } 




2684




 





 





 





 





 





 



     }, 




2685




 





 





 





 





 





 



     from1 => { 




2686




 





 





 





 





 





 



       # DATE 




2687




 





 





 





 





 





 



       9 => sub { ... }, 




2688




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2689




 





 





 





 





 





 



       11 => sub { ... }, 




2690




 





 





 





 





 





 



     } 




2691




 





 





 





 





 





 



     from2 => { 




2692




 





 





 





 





 





 



       # DATE 




2693




 





 





 





 





 





 



       9 => sub { ... }, 




2694




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2695




 





 





 





 





 





 



       11 => sub { ... }, 




2696




 





 





 





 





 





 



     } 




2697




 





 





 





 





 





 



   ); 




2698




 





 





 





 





 





 



   




2699




 





 





 





 





 





 



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




2700




 





 





 





 





 





 



 This has a little complex problem. 




2701




 





 





 





 





 





 



   




2702




 





 





 





 





 





 



 In C and C you can specify 




2703




 





 





 





 





 





 



 type name as same as type name defined 




2704




 





 





 





 





 





 



 by create table, such as C or C. 




2705




 





 





 





 





 





 



   




2706




 





 





 





 





 





 



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




2707




 





 





 





 





 





 



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




2708




 





 





 





 





 





 



   




2709




 





 





 





 





 





 



 C is executed after C. 




2710




 





 





 





 





 





 



   




2711




 





 





 





 





 





 



 Type rule of C and C is enabled on the following 




2712




 





 





 





 





 





 



 column name. 




2713




 





 





 





 





 





 



   




2714




 





 





 





 





 





 



 =over 4 




2715




 





 





 





 





 





 



   




2716




 





 





 





 





 





 



 =item 1. column name 




2717




 





 





 





 





 





 



   




2718




 





 





 





 





 





 



   issue_date 




2719




 





 





 





 





 





 



   issue_datetime 




2720




 





 





 





 





 





 



   




2721




 





 





 





 





 





 



 This need C option in each method. 




2722




 





 





 





 





 





 



   




2723




 





 





 





 





 





 



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




2724




 





 





 





 





 





 



   




2725




 





 





 





 





 





 



   book.issue_date 




2726




 





 





 





 





 





 



   book.issue_datetime 




2727




 





 





 





 





 





 



   




2728




 





 





 





 





 





 



 =back 




2729




 





 





 





 





 





 



   




2730




 





 





 





 





 





 



 You get all type name used in database by C. 




2731




 





 





 





 





 





 



   




2732




 





 





 





 





 





 



   print $dbi->available_typename; 




2733




 





 





 





 





 





 



   




2734




 





 





 





 





 





 



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




2735




 





 





 





 





 





 



 C is executed after C. 




2736




 





 





 





 





 





 



 You get all data type by C. 




2737




 





 





 





 





 





 



   




2738




 





 





 





 





 





 



   print $dbi->available_datatype; 




2739




 





 





 





 





 





 



   




2740




 





 





 





 





 





 



 You can also specify multiple types at once. 




2741




 





 





 





 





 





 



   




2742




 





 





 





 





 





 



   $dbi->type_rule( 




2743




 





 





 





 





 





 



     into1 => [ 




2744




 





 





 





 





 





 



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




2745




 





 





 





 





 





 



     ], 




2746




 





 





 





 





 





 



   ); 




2747




 





 





 





 





 





 



   




2748




 





 





 





 





 





 



 =head2 update 




2749




 





 





 





 





 





 



   




2750




 





 





 





 





 





 



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




2751




 





 





 





 





 





 



   




2752




 





 





 





 





 





 



 Execute update statement. First argument is update row data. 




2753




 





 





 





 





 





 



   




2754




 





 





 





 





 





 



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




2755




 





 





 





 





 





 



 as parameter value. 




2756




 





 





 





 





 





 



   




2757




 





 





 





 





 





 



   {date => \"NOW()"} 




2758




 





 





 





 





 





 



   




2759




 





 





 





 





 





 



 B 




2760




 





 





 





 





 





 



   




2761




 





 





 





 





 





 



 C method use all of C method's options, 




2762




 





 





 





 





 





 



 and use the following new ones. 




2763




 





 





 





 





 





 



   




2764




 





 





 





 





 





 



 =over 4 




2765




 





 





 





 





 





 



   




2766




 





 





 





 





 





 



 =item prefix 




2767




 





 





 





 





 





 



   




2768




 





 





 





 





 





 



   prefix => 'or replace' 




2769




 





 





 





 





 





 



   




2770




 





 





 





 





 





 



 prefix before table name section 




2771




 





 





 





 





 





 



   




2772




 





 





 





 





 





 



   update or replace book 




2773




 





 





 





 





 





 



   




2774




 





 





 





 





 





 



 =item table 




2775




 





 





 





 





 





 



   




2776




 





 





 





 





 





 



   table => 'book' 




2777




 





 





 





 





 





 



   




2778




 





 





 





 





 





 



 Table name. 




2779




 





 





 





 





 





 



   




2780




 





 





 





 





 





 



 =item where 




2781




 





 





 





 





 





 



   




2782




 





 





 





 





 





 



 Same as C method's C option. 




2783




 





 





 





 





 





 



   




2784




 





 





 





 





 





 



 =item wrap 




2785




 





 





 





 





 





 



   




2786




 





 





 





 





 





 



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




2787




 





 





 





 





 





 



   




2788




 





 





 





 





 





 



 placeholder wrapped string. 




2789




 





 





 





 





 





 



   




2790




 





 





 





 





 





 



 If the following statement 




2791




 





 





 





 





 





 



   




2792




 





 





 





 





 





 



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




2793




 





 





 





 





 





 



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




2794




 





 





 





 





 





 



   




2795




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2796




 





 





 





 





 





 



   




2797




 





 





 





 





 





 



   update book set price =  ? + 5; 




2798




 





 





 





 





 





 



   




2799




 





 





 





 





 





 



 =item mtime 




2800




 





 





 





 





 





 



   




2801




 





 





 





 





 





 



   mtime => 'modified_time' 




2802




 





 





 





 





 





 



   




2803




 





 





 





 





 





 



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




2804




 





 





 





 





 





 



 default time format is C, which can be changed by 




2805




 





 





 





 





 





 



 C attribute. 




2806




 





 





 





 





 





 



   




2807




 





 





 





 





 





 



 =back 




2808




 





 





 





 





 





 



   




2809




 





 





 





 





 





 



 =head2 update_all 




2810




 





 





 





 





 





 



   




2811




 





 





 





 





 





 



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




2812




 





 





 





 





 





 



   




2813




 





 





 





 





 





 



 Execute update statement for all rows. 




2814




 





 





 





 





 





 



 Options is same as C method. 




2815




 





 





 





 





 





 



   




2816




 





 





 





 





 





 



 =over 4 




2817




 





 





 





 





 





 



   




2818




 





 





 





 





 





 



 =item option 




2819




 





 





 





 





 





 



   




2820




 





 





 





 





 





 



   option => { 




2821




 





 





 





 





 





 



     select => { 




2822




 





 





 





 





 





 



       append => '...' 




2823




 





 





 





 





 





 



     }, 




2824




 





 





 





 





 





 



     insert => { 




2825




 





 





 





 





 





 



       prefix => '...' 




2826




 





 





 





 





 





 



     }, 




2827




 





 





 





 





 





 



     update => { 




2828




 





 





 





 





 





 



       filter => {} 




2829




 





 





 





 





 





 



     } 




2830




 





 





 





 





 





 



   } 




2831




 





 





 





 





 





 



   




2832




 





 





 





 





 





 



 If you want to pass option to each method, 




2833




 





 





 





 





 





 



 you can use C option. 




2834




 





 





 





 





 





 



   




2835




 





 





 





 





 





 



 =over 4 




2836




 





 





 





 





 





 



   




2837




 





 





 





 





 





 



 =item select_option 




2838




 





 





 





 





 





 



   




2839




 





 





 





 





 





 



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




2840




 





 





 





 





 





 



   




2841




 





 





 





 





 





 



 select method option, 




2842




 





 





 





 





 





 



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




2843




 





 





 





 





 





 



   




2844




 





 





 





 





 





 



 =head2 show_datatype 




2845




 





 





 





 





 





 



   




2846




 





 





 





 





 





 



   $dbi->show_datatype($table); 




2847




 





 





 





 





 





 



   




2848




 





 





 





 





 





 



 Show data type of the columns of specified table. 




2849




 





 





 





 





 





 



   




2850




 





 





 





 





 





 



   book 




2851




 





 





 





 





 





 



   title: 5 




2852




 





 





 





 





 





 



   issue_date: 91 




2853




 





 





 





 





 





 



   




2854




 





 





 





 





 





 



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




2855




 





 





 





 





 





 



   




2856




 





 





 





 





 





 



 =head2 show_tables 




2857




 





 





 





 





 





 



   




2858




 





 





 





 





 





 



   $dbi->show_tables; 




2859




 





 





 





 





 





 



   




2860




 





 





 





 





 





 



 Show tables. 




2861




 





 





 





 





 





 



   




2862




 





 





 





 





 





 



 =head2 show_typename 




2863




 





 





 





 





 





 



   




2864




 





 





 





 





 





 



   $dbi->show_typename($table); 




2865




 





 





 





 





 





 



   




2866




 





 





 





 





 





 



 Show type name of the columns of specified table. 




2867




 





 





 





 





 





 



   




2868




 





 





 





 





 





 



   book 




2869




 





 





 





 





 





 



   title: varchar 




2870




 





 





 





 





 





 



   issue_date: date 




2871




 





 





 





 





 





 



   




2872




 





 





 





 





 





 



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




2873




 





 





 





 





 





 



   




2874




 





 





 





 





 





 



 =head2 values_clause 




2875




 





 





 





 





 





 



   




2876




 





 





 





 





 





 



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




2877




 





 





 





 





 





 



   




2878




 





 





 





 





 





 



 Create values clause. 




2879




 





 





 





 





 





 



   




2880




 





 





 





 





 





 



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




2881




 





 





 





 





 





 



   




2882




 





 





 





 





 





 



 You can use this in insert statement. 




2883




 





 





 





 





 





 



   




2884




 





 





 





 





 





 



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




2885




 





 





 





 





 





 



   




2886




 





 





 





 





 





 



 =head2 where 




2887




 





 





 





 





 





 



   




2888




 





 





 





 





 





 



   my $where = $dbi->where; 




2889




 





 





 





 





 





 



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




2890




 





 





 





 





 





 



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




2891




 





 





 





 





 





 



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




2892




 





 





 





 





 





 



   




2893




 





 





 





 





 





 



 Create a new L object. 




2894




 





 





 





 





 





 



 See L to know how to create where clause. 




2895




 





 





 





 





 





 



   




2896




 





 





 





 





 





 



 =head1 ENVIRONMENTAL VARIABLES 




2897




 





 





 





 





 





 



   




2898




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG 




2899




 





 





 





 





 





 



   




2900




 





 





 





 





 





 



 If environment variable C is set to true, 




2901




 





 





 





 





 





 



 executed SQL and bind values are printed to STDERR. 




2902




 





 





 





 





 





 



   




2903




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG_ENCODING 




2904




 





 





 





 





 





 



   




2905




 





 





 





 





 





 



 DEBUG output encoding. Default to UTF-8. 




2906




 





 





 





 





 





 



   




2907




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION 




2908




 





 





 





 





 





 



   




2909




 





 





 





 





 





 



   $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25'; 




2910




 





 





 





 





 





 



   




2911




 





 





 





 





 





 



 Suppress deprecation warnings before specified version. 




2912




 





 





 





 





 





 



   




2913




 





 





 





 





 





 



 =head1 DEPRECATED FUNCTIONALITY 




2914




 





 





 





 





 





 



   




2915




 





 





 





 





 





 



 L 




2916




 





 





 





 





 





 



   




2917




 





 





 





 





 





 



   # Methods 




2918




 





 





 





 





 





 



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




2919




 





 





 





 





 





 



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




2920




 





 





 





 





 





 



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




2921




 





 





 





 





 





 



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




2922




 





 





 





 





 





 



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




2923




 





 





 





 





 





 



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




2924




 





 





 





 





 





 



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




2925




 





 





 





 





 





 



   




2926




 





 





 





 





 





 



 L 




2927




 





 





 





 





 





 



    




2928




 





 





 





 





 





 



   # Options 




2929




 





 





 





 





 





 



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




2930




 





 





 





 





 





 



   




2931




 





 





 





 





 





 



 L 




2932




 





 





 





 





 





 



   




2933




 





 





 





 





 





 



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




2934




 





 





 





 





 





 



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




2935




 





 





 





 





 





 



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




2936




 





 





 





 





 





 



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




2937




 





 





 





 





 





 



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




2938




 





 





 





 





 





 



   




2939




 





 





 





 





 





 



 =head1 BACKWARDS COMPATIBILITY POLICY 




2940




 





 





 





 





 





 



   




2941




 





 





 





 





 





 



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




2942




 





 





 





 





 





 



 DEPRECATED feature is removed after C, 




2943




 





 





 





 





 





 



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




2944




 





 





 





 





 





 



 I extend one year each time he tell me it. 




2945




 





 





 





 





 





 



   




2946




 





 





 





 





 





 



 DEPRECATION warnings can be suppressed by C 




2947




 





 





 





 





 





 



 environment variable. 




2948




 





 





 





 





 





 



   




2949




 





 





 





 





 





 



 EXPERIMENTAL features will be changed or deleted without warnings. 




2950




 





 





 





 





 





 



   




2951




 





 





 





 





 





 



 =head1 BUGS 




2952




 





 





 





 





 





 



   




2953




 





 





 





 





 





 



 Please tell me bugs if you find bug. 




2954




 





 





 





 





 





 



   




2955




 





 





 





 





 





 



 C<<  >> 




2956




 





 





 





 





 





 



   




2957




 





 





 





 





 





 



 L 




2958




 





 





 





 





 





 



   




2959




 





 





 





 





 





 



 =head1 AUTHOR 




2960




 





 





 





 





 





 



   




2961




 





 





 





 





 





 



 Yuki Kimoto, C<<  >> 




2962




 





 





 





 





 





 



   




2963




 





 





 





 





 





 



 =head1 COPYRIGHT & LICENSE 




2964




 





 





 





 





 





 



   




2965




 





 





 





 





 





 



 Copyright 2009-2019 Yuki Kimoto, all rights reserved. 




2966




 





 





 





 





 





 



   




2967




 





 





 





 





 





 



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




2968




 





 





 





 





 





 



 under the same terms as Perl itself. 




2969




 





 





 





 





 





 



   




2970




 





 





 





 





 





 



 =cut
C. 




2088




 





 





 





 





 





 



   




2089




 





 





 





 





 





 



 If C is set, C method use C 




2090




 





 





 





 





 





 



 information, you can improve the performance of C in 




2091




 





 





 





 





 





 



 the following way. 




2092




 





 





 





 





 





 



   




2093




 





 





 





 





 





 



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




2094




 





 





 





 





 





 



   $dbi->user_table_info($table_info); 




2095




 





 





 





 





 





 



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




2096




 





 





 





 





 





 



   




2097




 





 





 





 





 





 



 =head2 execute 




2098




 





 





 





 





 





 



   




2099




 





 





 





 





 





 



   my $result = $dbi->execute( 




2100




 





 





 





 





 





 



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




2101




 





 





 





 





 





 



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




2102




 





 





 





 





 





 



   ); 




2103




 





 





 





 





 





 



   




2104




 





 





 





 





 





 



   my $result = $dbi->execute( 




2105




 





 





 





 





 





 



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




2106




 





 





 





 





 





 



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




2107




 





 





 





 





 





 



   ); 




2108




 





 





 





 





 





 



   




2109




 





 





 





 





 





 



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




2110




 





 





 





 





 





 



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




2111




 





 





 





 





 





 



 Second argument is data, embedded into column parameter. 




2112




 





 





 





 





 





 



 Return value is L object when select statement is executed, 




2113




 





 





 





 





 





 



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




2114




 





 





 





 





 





 



   




2115




 





 





 





 





 





 



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




2116




 





 





 





 





 





 



    




2117




 





 





 





 





 





 



   # Original 




2118




 





 





 





 





 





 



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




2119




 





 





 





 





 





 



    




2120




 





 





 





 





 





 



   # Replaced 




2121




 





 





 





 





 





 



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




2122




 





 





 





 





 





 



   




2123




 





 





 





 





 





 



 You can specify operator with named placeholder 




2124




 





 





 





 





 





 



 by C syntax. 




2125




 





 





 





 





 





 



   




2126




 





 





 





 





 





 



   # Original 




2127




 





 





 





 





 





 



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




2128




 





 





 





 





 





 



    




2129




 





 





 





 





 





 



   # Replaced 




2130




 





 





 





 





 





 



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




2131




 





 





 





 





 





 



   




2132




 





 





 





 





 





 



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




2133




 





 





 





 





 





 



 it is not parsed as named placeholder. 




2134




 





 





 





 





 





 



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




2135




 





 





 





 





 





 



   




2136




 





 





 





 





 





 



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




2137




 





 





 





 





 





 



   




2138




 





 





 





 





 





 



 B 




2139




 





 





 





 





 





 



   




2140




 





 





 





 





 





 



 The following options are available. 




2141




 





 





 





 





 





 



   




2142




 





 





 





 





 





 



 =over 4 




2143




 





 





 





 





 





 



   




2144




 





 





 





 





 





 



 =item after_build_sql  




2145




 





 





 





 





 





 



   




2146




 





 





 





 





 





 



 You can filter sql after the sql is build. 




2147




 





 





 





 





 





 



   




2148




 





 





 





 





 





 



   after_build_sql => $code_ref 




2149




 





 





 





 





 





 



   




2150




 





 





 





 





 





 



 The following one is one example. 




2151




 





 





 





 





 





 



   




2152




 





 





 





 





 





 



   $dbi->select( 




2153




 





 





 





 





 





 



     table => 'book', 




2154




 





 





 





 





 





 



     column => 'distinct(name)', 




2155




 





 





 





 





 





 



     after_build_sql => sub { 




2156




 





 





 





 





 





 



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




2157




 





 





 





 





 





 



     } 




2158




 





 





 





 





 





 



   ); 




2159




 





 





 





 





 





 



   




2160




 





 





 





 





 





 



 The following SQL is executed. 




2161




 





 





 





 





 





 



   




2162




 





 





 





 





 





 



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




2163




 





 





 





 





 





 



   




2164




 





 





 





 





 





 



 =item append 




2165




 





 





 





 





 





 



   




2166




 





 





 





 





 





 



   append => 'order by name' 




2167




 





 





 





 





 





 



   




2168




 





 





 





 





 





 



 Append some statement after SQL. 




2169




 





 





 





 





 





 



   




2170




 





 





 





 





 





 



 =item bind_type 




2171




 





 





 





 





 





 



   




2172




 





 





 





 





 





 



 Specify database bind data type. 




2173




 





 





 





 





 





 



    




2174




 





 





 





 





 





 



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




2175




 





 





 





 





 





 



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




2176




 





 





 





 





 





 



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




2177




 





 





 





 





 





 



   




2178




 





 





 





 





 





 



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




2179




 





 





 





 





 





 



   




2180




 





 





 





 





 





 



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




2181




 





 





 





 





 





 



   




2182




 





 





 





 





 





 



 =item filter 




2183




 





 





 





 





 





 



    




2184




 





 





 





 





 





 



   filter => { 




2185




 





 





 





 





 





 



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




2186




 





 





 





 





 





 



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




2187




 





 





 





 





 





 



   } 




2188




 





 





 





 





 





 



   




2189




 





 





 





 





 





 



   # Filter name 




2190




 





 





 





 





 





 



   filter => { 




2191




 





 





 





 





 





 



     title  => 'upper_case', 




2192




 





 





 





 





 





 



     author => 'upper_case' 




2193




 





 





 





 





 





 



   } 




2194




 





 





 





 





 





 



        




2195




 





 





 





 





 





 



   # At once 




2196




 





 





 





 





 





 



   filter => [ 




2197




 





 





 





 





 





 



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




2198




 





 





 





 





 





 



   ] 




2199




 





 





 





 





 





 



   




2200




 





 





 





 





 





 



 Filter. You can set subroutine or filter name 




2201




 





 





 





 





 





 



 registered by C. 




2202




 





 





 





 





 





 



 This filter is executed before data is saved into database. 




2203




 





 





 





 





 





 



 and before type rule filter is executed. 




2204




 





 





 





 





 





 



   




2205




 





 





 





 





 





 



 =item reuse 




2206




 





 





 





 





 





 



    




2207




 





 





 





 





 





 



   reuse => $hash_ref 




2208




 





 





 





 





 





 



   




2209




 





 





 





 





 





 



 Reuse statement handle in same SQL. 




2210




 





 





 





 





 





 



    




2211




 





 





 





 





 





 



   my $reuse = {}; 




2212




 





 





 





 





 





 



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




2213




 





 





 





 





 





 



   




2214




 





 





 





 





 





 



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




2215




 





 





 





 





 





 



   




2216




 





 





 





 





 





 



 =item table 




2217




 





 





 





 





 





 



    




2218




 





 





 





 





 





 



   table => 'author' 




2219




 





 





 





 





 





 



   




2220




 





 





 





 





 





 



 If you want to omit table name in column name 




2221




 





 





 





 





 





 



 and enable C and C type filter, 




2222




 





 





 





 





 





 



 You must set C option. 




2223




 





 





 





 





 





 



   




2224




 





 





 





 





 





 



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




2225




 





 





 





 





 





 



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




2226




 





 





 





 





 





 



   




2227




 





 





 





 





 





 



   # Same 




2228




 





 





 





 





 





 



   $dbi->execute( 




2229




 





 





 





 





 





 



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




2230




 





 





 





 





 





 



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




2231




 





 





 





 





 





 



   




2232




 





 





 





 





 





 



 =item table_alias 




2233




 





 





 





 





 





 



   




2234




 





 





 





 





 





 



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




2235




 





 





 





 





 





 



   




2236




 





 





 





 





 





 



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




2237




 





 





 





 





 





 



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




2238




 





 





 





 





 





 



 on alias table name. 




2239




 





 





 





 





 





 



   




2240




 





 





 





 





 





 



 =item type_rule_off 




2241




 





 





 





 





 





 



   




2242




 





 





 





 





 





 



   type_rule_off => 1 




2243




 





 





 





 





 





 



   




2244




 





 





 





 





 





 



 Turn C and C type rule off. 




2245




 





 





 





 





 





 



   




2246




 





 





 





 





 





 



 =item type_rule1_off 




2247




 





 





 





 





 





 



   




2248




 





 





 





 





 





 



   type_rule1_off => 1 




2249




 





 





 





 





 





 



   




2250




 





 





 





 





 





 



 Turn C type rule off. 




2251




 





 





 





 





 





 



   




2252




 





 





 





 





 





 



 =item type_rule2_off 




2253




 





 





 





 





 





 



   




2254




 





 





 





 





 





 



   type_rule2_off => 1 




2255




 





 





 





 





 





 



   




2256




 





 





 





 





 





 



 Turn C type rule off. 




2257




 





 





 





 





 





 



   




2258




 





 





 





 





 





 



 =head2 get_column_info 




2259




 





 





 





 





 





 



   




2260




 





 





 





 





 





 



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




2261




 





 





 





 





 





 



   




2262




 





 





 





 





 





 



 get column information except for one which match C pattern. 




2263




 





 





 





 





 





 



   




2264




 





 





 





 





 





 



   [ 




2265




 





 





 





 





 





 



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




2266




 





 





 





 





 





 



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




2267




 





 





 





 





 





 



   ] 




2268




 





 





 





 





 





 



   




2269




 





 





 





 





 





 



 =head2 get_table_info 




2270




 





 





 





 





 





 



   




2271




 





 





 





 





 





 



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




2272




 





 





 





 





 





 



   




2273




 





 





 





 





 





 



 get table information except for one which match C pattern. 




2274




 





 





 





 





 





 



   




2275




 





 





 





 





 





 



   [ 




2276




 





 





 





 





 





 



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




2277




 





 





 





 





 





 



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




2278




 





 





 





 





 





 



   ] 




2279




 





 





 





 





 





 



   




2280




 





 





 





 





 





 



 You can set this value to C. 




2281




 





 





 





 





 





 



   




2282




 





 





 





 





 





 



 =head2 insert 




2283




 





 





 





 





 





 



   




2284




 





 





 





 





 





 



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




2285




 





 





 





 





 





 



   




2286




 





 





 





 





 





 



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




2287




 





 





 





 





 





 



 affected row count. 




2288




 





 





 





 





 





 



   




2289




 





 





 





 





 





 



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




2290




 





 





 





 





 





 



 as parameter value. 




2291




 





 





 





 





 





 



   




2292




 





 





 





 





 





 



   {date => \"NOW()"} 




2293




 





 





 





 





 





 



   




2294




 





 





 





 





 





 



 You can pass multiple parameters, this is very fast. 




2295




 





 





 





 





 





 



   




2296




 





 





 





 





 





 



   $dbi->insert( 




2297




 





 





 





 





 





 



     [ 




2298




 





 





 





 





 





 



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




2299




 





 





 





 





 





 



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




2300




 





 





 





 





 





 



     ], 




2301




 





 





 





 





 





 



     table  => 'book' 




2302




 





 





 





 





 





 



   ); 




2303




 





 





 





 





 





 



   




2304




 





 





 





 





 





 



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




2305




 





 





 





 





 





 



 and only first parameter is used to create sql. 




2306




 





 





 





 





 





 



   




2307




 





 





 





 





 





 



 B 




2308




 





 





 





 





 





 



   




2309




 





 





 





 





 





 



 C method use all of C method's options, 




2310




 





 





 





 





 





 



 and use the following new ones. 




2311




 





 





 





 





 





 



   




2312




 





 





 





 





 





 



 =over 4 




2313




 





 





 





 





 





 



   




2314




 





 





 





 





 





 



 =item bulk_insert 




2315




 





 





 





 





 





 



   




2316




 





 





 





 





 





 



   bulk_insert => 1 




2317




 





 





 





 





 





 



   




2318




 





 





 





 





 





 



 bulk insert is executed if database support bulk insert and  




2319




 





 





 





 





 





 



 multiple parameters is passed to C. 




2320




 





 





 





 





 





 



 The SQL like the following one is executed. 




2321




 





 





 





 





 





 



   




2322




 





 





 





 





 





 



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




2323




 





 





 





 





 





 



   




2324




 





 





 





 





 





 



 =item ctime 




2325




 





 





 





 





 





 



   




2326




 





 





 





 





 





 



   ctime => 'created_time' 




2327




 





 





 





 





 





 



   




2328




 





 





 





 





 





 



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




2329




 





 





 





 





 





 



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




2330




 





 





 





 





 





 



 C attribute. 




2331




 





 





 





 





 





 



   




2332




 





 





 





 





 





 



 =item prefix 




2333




 





 





 





 





 





 



   




2334




 





 





 





 





 





 



   prefix => 'or replace' 




2335




 





 





 





 





 





 



   




2336




 





 





 





 





 





 



 prefix before table name section 




2337




 





 





 





 





 





 



   




2338




 





 





 





 





 





 



   insert or replace into book 




2339




 





 





 





 





 





 



   




2340




 





 





 





 





 





 



 =item table 




2341




 





 





 





 





 





 



   




2342




 





 





 





 





 





 



   table => 'book' 




2343




 





 





 





 





 





 



   




2344




 





 





 





 





 





 



 Table name. 




2345




 





 





 





 





 





 



   




2346




 





 





 





 





 





 



 =item mtime 




2347




 





 





 





 





 





 



   




2348




 





 





 





 





 





 



 This option is same as C method C option. 




2349




 





 





 





 





 





 



   




2350




 





 





 





 





 





 



 =item wrap 




2351




 





 





 





 





 





 



   




2352




 





 





 





 





 





 



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




2353




 





 





 





 





 





 



   




2354




 





 





 





 





 





 



 placeholder wrapped string. 




2355




 





 





 





 





 





 



   




2356




 





 





 





 





 





 



 If the following statement 




2357




 





 





 





 





 





 



   




2358




 





 





 





 





 





 



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




2359




 





 





 





 





 





 



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




2360




 





 





 





 





 





 



   




2361




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2362




 





 





 





 





 





 



   




2363




 





 





 





 





 





 



   insert into book price values ( ? + 5 ); 




2364




 





 





 





 





 





 



   




2365




 





 





 





 





 





 



 =back 




2366




 





 





 





 





 





 



   




2367




 





 





 





 





 





 



 =over 4 




2368




 





 





 





 





 





 



   




2369




 





 





 





 





 





 



 =head2 include_model 




2370




 





 





 





 





 





 



   




2371




 





 





 





 





 





 



   $dbi->include_model('MyModel'); 




2372




 





 





 





 





 





 



   




2373




 





 





 





 





 





 



 Include models from specified namespace, 




2374




 





 





 





 





 





 



 the following layout is needed to include models. 




2375




 





 





 





 





 





 



   




2376




 





 





 





 





 





 



   lib / MyModel.pm 




2377




 





 





 





 





 





 



       / MyModel / book.pm 




2378




 





 





 





 





 





 



                 / company.pm 




2379




 





 





 





 





 





 



   




2380




 





 





 





 





 





 



 Name space module, extending L. 




2381




 





 





 





 





 





 



   




2382




 





 





 





 





 





 



 B 




2383




 





 





 





 





 





 



   




2384




 





 





 





 





 





 



   package MyModel; 




2385




 





 





 





 





 





 



   use DBIx::Custom::Model -base; 




2386




 





 





 





 





 





 



    




2387




 





 





 





 





 





 



   1; 




2388




 





 





 





 





 





 



   




2389




 





 





 





 





 





 



 Model modules, extending name space module. 




2390




 





 





 





 





 





 



   




2391




 





 





 





 





 





 



 B 




2392




 





 





 





 





 





 



   




2393




 





 





 





 





 





 



   package MyModel::book; 




2394




 





 





 





 





 





 



   use MyModel -base; 




2395




 





 





 





 





 





 



    




2396




 





 





 





 





 





 



   1; 




2397




 





 





 





 





 





 



   




2398




 





 





 





 





 





 



 B 




2399




 





 





 





 





 





 



   




2400




 





 





 





 





 





 



   package MyModel::company; 




2401




 





 





 





 





 





 



   use MyModel -base; 




2402




 





 





 





 





 





 



    




2403




 





 





 





 





 





 



   1; 




2404




 





 





 





 





 





 



    




2405




 





 





 





 





 





 



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




2406




 





 





 





 





 





 



   




2407




 





 





 





 





 





 



 You can get model object by C. 




2408




 





 





 





 





 





 



   




2409




 





 





 





 





 





 



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




2410




 





 





 





 





 





 



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




2411




 





 





 





 





 





 



   




2412




 





 





 





 





 





 



 You can include full-qualified table name like C 




2413




 





 





 





 





 





 



   




2414




 





 





 





 





 





 



   lib / MyModel.pm 




2415




 





 





 





 





 





 



       / MyModel / main / book.pm 




2416




 





 





 





 





 





 



                        / company.pm 




2417




 





 





 





 





 





 



   




2418




 





 





 





 





 





 



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




2419




 





 





 





 





 





 



   




2420




 





 





 





 





 





 



 See L to know model features. 




2421




 





 





 





 





 





 



   




2422




 





 





 





 





 





 



 =head2 like_value 




2423




 





 





 





 





 





 



   




2424




 





 





 





 





 





 



   my $like_value = $dbi->like_value 




2425




 





 





 





 





 





 



   




2426




 





 





 





 





 





 



 Code reference which return a value for the like value. 




2427




 





 





 





 





 





 



   




2428




 





 





 





 





 





 



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




2429




 





 





 





 





 





 



   




2430




 





 





 





 





 





 



 =head2 mapper 




2431




 





 





 





 





 





 



   




2432




 





 





 





 





 





 



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




2433




 





 





 





 





 





 



   




2434




 





 





 





 





 





 



 Create a new L object. 




2435




 





 





 





 





 





 



   




2436




 





 





 





 





 





 



 =head2 merge_param 




2437




 





 





 





 





 





 



   




2438




 





 





 





 





 





 



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




2439




 





 





 





 





 





 



   




2440




 





 





 





 





 





 



 Merge parameters. The following new parameter is created. 




2441




 





 





 





 





 





 



   




2442




 





 





 





 





 





 



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




2443




 





 





 





 





 





 



   




2444




 





 





 





 





 





 



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




2445




 





 





 





 





 





 



   




2446




 





 





 





 





 





 



 =head2 model 




2447




 





 





 





 





 





 



   




2448




 





 





 





 





 





 



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




2449




 





 





 





 





 





 



   




2450




 





 





 





 





 





 



 Get a L object 




2451




 





 





 





 





 





 



 create by C or C 




2452




 





 





 





 





 





 



   




2453




 





 





 





 





 





 



 =head2 mycolumn 




2454




 





 





 





 





 





 



   




2455




 





 





 





 





 





 



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




2456




 





 





 





 





 





 



   




2457




 





 





 





 





 





 



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




2458




 





 





 





 





 





 



   




2459




 





 





 





 





 





 



   book.author as author, 




2460




 





 





 





 





 





 



   book.title as title 




2461




 





 





 





 





 





 



   




2462




 





 





 





 





 





 



 =head2 new 




2463




 





 





 





 





 





 



   




2464




 





 





 





 





 





 



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




2465




 





 





 





 





 





 



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




2466




 





 





 





 





 





 



     user => 'ken', 




2467




 





 





 





 





 





 



     password => '!LFKD%$&', 




2468




 





 





 





 





 





 



     option => {mysql_enable_utf8 => 1} 




2469




 





 





 





 





 





 



   ); 




2470




 





 





 





 





 





 



   




2471




 





 





 





 





 





 



 Create a new L object. 




2472




 





 





 





 





 





 



   




2473




 





 





 





 





 





 



 =head2 not_exists 




2474




 





 





 





 





 





 



   




2475




 





 





 





 





 





 



   my $not_exists = $dbi->not_exists; 




2476




 





 





 





 





 





 



   




2477




 





 





 





 





 





 



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




2478




 





 





 





 





 





 



 This is used in C of L . 




2479




 





 





 





 





 





 



   




2480




 





 





 





 





 





 



 =head2 order 




2481




 





 





 





 





 





 



   




2482




 





 





 





 





 





 



   my $order = $dbi->order; 




2483




 





 





 





 





 





 



   




2484




 





 





 





 





 





 



 Create a new L object. 




2485




 





 





 





 





 





 



   




2486




 





 





 





 





 





 



 =head2 q 




2487




 





 





 





 





 





 



   




2488




 





 





 





 





 





 



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




2489




 





 





 





 





 





 



   




2490




 





 





 





 





 





 



 Quote string by value of C. 




2491




 





 





 





 





 





 



   




2492




 





 





 





 





 





 



 =head2 register_filter 




2493




 





 





 





 





 





 



   




2494




 





 





 





 





 





 



   $dbi->register_filter( 




2495




 





 





 





 





 





 



     # Time::Piece object to database DATE format 




2496




 





 





 





 





 





 



     tp_to_date => sub { 




2497




 





 





 





 





 





 



       my $tp = shift; 




2498




 





 





 





 





 





 



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




2499




 





 





 





 





 





 



     }, 




2500




 





 





 





 





 





 



     # database DATE format to Time::Piece object 




2501




 





 





 





 





 





 



     date_to_tp => sub { 




2502




 





 





 





 





 





 



       my $date = shift; 




2503




 





 





 





 





 





 



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




2504




 





 





 





 





 





 



     } 




2505




 





 





 





 





 





 



   ); 




2506




 





 





 





 





 





 



    




2507




 





 





 





 





 





 



 Register filters, used by C option of many methods. 




2508




 





 





 





 





 





 



   




2509




 





 





 





 





 





 



 =head2 select 




2510




 





 





 





 





 





 



   




2511




 





 





 





 





 





 



   my $result = $dbi->select( 




2512




 





 





 





 





 





 



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




2513




 





 





 





 





 





 



     table  => 'book', 




2514




 





 





 





 





 





 



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




2515




 





 





 





 





 





 



   ); 




2516




 





 





 





 





 





 



    




2517




 





 





 





 





 





 



 Execute select statement. 




2518




 





 





 





 





 





 



   




2519




 





 





 





 





 





 



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




2520




 





 





 





 





 





 



   




2521




 





 





 





 





 





 



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




2522




 





 





 





 





 





 



   




2523




 





 





 





 





 





 



 B 




2524




 





 





 





 





 





 



   




2525




 





 





 





 





 





 



 C method use all of C method's options, 




2526




 





 





 





 





 





 



 and use the following new ones. 




2527




 





 





 





 





 





 



   




2528




 





 





 





 





 





 



 =over 4 




2529




 





 





 





 





 





 



   




2530




 





 





 





 





 





 



 =item column 




2531




 





 





 





 





 





 



    




2532




 





 





 





 





 





 



   column => 'author' 




2533




 





 





 





 





 





 



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




2534




 





 





 





 





 





 



   




2535




 





 





 





 





 





 



 Column clause. 




2536




 





 





 





 





 





 



    




2537




 





 





 





 





 





 



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




2538




 





 





 





 





 





 



   




2539




 





 





 





 





 





 



   column => '*' 




2540




 





 





 





 





 





 



   




2541




 





 





 





 





 





 



 You can specify hash of array reference. 




2542




 





 





 





 





 





 



   




2543




 





 





 





 





 





 



   column => [ 




2544




 





 





 





 





 





 



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




2545




 





 





 





 





 





 



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




2546




 





 





 





 





 





 



   ] 




2547




 





 





 





 





 





 



   




2548




 





 





 





 





 





 



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




2549




 





 





 





 





 





 



   




2550




 





 





 





 





 





 



   book.author as "book.author", 




2551




 





 





 





 





 





 



   book.title as "book.title", 




2552




 





 





 





 





 





 



   person.name as "person.name", 




2553




 





 





 





 





 





 



   person.age as "person.age" 




2554




 





 





 





 





 





 



   




2555




 





 





 





 





 





 



 You can specify own column by C<__MY__>. 




2556




 





 





 





 





 





 



   




2557




 





 





 





 





 





 



   column => [ 




2558




 





 





 





 





 





 



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




2559




 





 





 





 





 





 



   ] 




2560




 





 





 





 





 





 



   




2561




 





 





 





 





 





 



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




2562




 





 





 





 





 





 



   




2563




 





 





 





 





 





 



   book.author as "author", 




2564




 





 





 





 





 





 



   book.title as "title", 




2565




 





 





 





 





 





 



   




2566




 





 





 





 





 





 



 C<__MY__> can be changed by C attribute. 




2567




 





 





 





 





 





 



   




2568




 





 





 





 





 





 



 =item param 




2569




 





 





 





 





 





 



   




2570




 





 





 





 





 





 



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




2571




 





 





 





 





 





 



   




2572




 





 





 





 





 





 



 Parameter shown before where clause. 




2573




 





 





 





 





 





 



    




2574




 





 





 





 





 





 



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




2575




 





 





 





 





 





 



 you can pass parameter by C option. 




2576




 





 





 





 





 





 



   




2577




 





 





 





 





 





 



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




2578




 





 





 





 





 





 



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




2579




 





 





 





 





 





 



   




2580




 





 





 





 





 





 



 =item prefix 




2581




 





 





 





 





 





 



   




2582




 





 





 





 





 





 



   prefix => 'SQL_CALC_FOUND_ROWS' 




2583




 





 





 





 





 





 



   




2584




 





 





 





 





 





 



 Prefix of column clause 




2585




 





 





 





 





 





 



   




2586




 





 





 





 





 





 



   select SQL_CALC_FOUND_ROWS title, author from book; 




2587




 





 





 





 





 





 



   




2588




 





 





 





 





 





 



 =item join 




2589




 





 





 





 





 





 



   




2590




 





 





 





 





 





 



   join => [ 




2591




 





 





 





 





 





 



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




2592




 





 





 





 





 





 



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




2593




 





 





 





 





 





 



   ] 




2594




 





 





 





 





 





 



        




2595




 





 





 





 





 





 



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




2596




 





 





 





 





 





 



 join clauses needed when SQL is created is used automatically. 




2597




 





 





 





 





 





 



   




2598




 





 





 





 





 





 



   $dbi->select( 




2599




 





 





 





 





 





 



     table => 'book', 




2600




 





 





 





 





 





 



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




2601




 





 





 





 





 





 



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




2602




 





 





 





 





 





 



     join => [ 




2603




 





 





 





 





 





 



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




2604




 





 





 





 





 





 



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




2605




 





 





 





 





 





 



     ] 




2606




 





 





 





 





 





 



   ); 




2607




 





 





 





 





 





 



   




2608




 





 





 





 





 





 



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




2609




 





 





 





 





 





 



 the following SQL is created 




2610




 





 





 





 





 





 



   




2611




 





 





 





 





 





 



   select company.location_id as location_id 




2612




 





 





 





 





 





 



   from book 




2613




 





 





 





 





 





 



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




2614




 





 





 





 





 





 



   where company.name = ?; 




2615




 





 





 





 





 





 



   




2616




 





 





 





 





 





 



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




2617




 





 





 





 





 





 



 the join clause correctly. 




2618




 





 





 





 





 





 



   




2619




 





 





 





 





 





 



   $dbi->select( 




2620




 





 





 





 





 





 



     table => 'book', 




2621




 





 





 





 





 





 



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




2622




 





 





 





 





 





 



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




2623




 





 





 





 





 





 



     join => [ 




2624




 





 





 





 





 





 



       { 




2625




 





 





 





 





 





 



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




2626




 





 





 





 





 





 



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




2627




 





 





 





 





 





 



       } 




2628




 





 





 





 





 





 



     ] 




2629




 





 





 





 





 





 



   ); 




2630




 





 





 





 





 





 



   




2631




 





 





 





 





 





 



 =item table 




2632




 





 





 





 





 





 



   




2633




 





 





 





 





 





 



   table => 'book' 




2634




 





 





 





 





 





 



   




2635




 





 





 





 





 





 



 Table name. 




2636




 





 





 





 





 





 



   




2637




 





 





 





 





 





 



 =item where 




2638




 





 





 





 





 





 



    




2639




 





 





 





 





 





 



   # (1) Hash reference 




2640




 





 





 





 





 





 



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




2641




 





 





 





 





 





 



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




2642




 





 





 





 





 





 



    




2643




 





 





 





 





 





 



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




2644




 





 





 





 





 





 



   where => $dbi->where( 




2645




 





 





 





 





 





 



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




2646




 





 





 





 





 





 



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




2647




 





 





 





 





 





 



   ) 




2648




 





 





 





 





 





 



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




2649




 





 





 





 





 





 



    




2650




 





 





 





 





 





 



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




2651




 





 





 





 





 





 



   where => [ 




2652




 





 





 





 





 





 



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




2653




 





 





 





 





 





 



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




2654




 





 





 





 





 





 



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




2655




 





 





 





 





 





 



   ] 




2656




 





 





 





 





 





 



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




2657




 





 





 





 





 





 



    




2658




 





 





 





 





 





 



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




2659




 





 





 





 





 





 



   where => [ 




2660




 





 





 





 





 





 



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




2661




 





 





 





 





 





 



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




2662




 





 





 





 





 





 



   ] 




2663




 





 





 





 





 





 



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




2664




 





 





 





 





 





 



    




2665




 





 





 





 





 





 



   # (5) String 




2666




 





 





 





 





 





 



   where => 'title is null' 




2667




 





 





 





 





 





 



   #  -> where title is null 




2668




 





 





 





 





 





 



   




2669




 





 





 





 





 





 



 Where clause. 




2670




 





 





 





 





 





 



 See also L to know how to create where clause. 




2671




 





 





 





 





 





 



    




2672




 





 





 





 





 





 



 =back 




2673




 





 





 





 





 





 



   




2674




 





 





 





 





 





 



 =head2 type_rule 




2675




 





 





 





 





 





 



   




2676




 





 





 





 





 





 



   $dbi->type_rule( 




2677




 





 





 





 





 





 



     into1 => { 




2678




 





 





 





 





 





 



       date => sub { ... }, 




2679




 





 





 





 





 





 



       datetime => sub { ... } 




2680




 





 





 





 





 





 



     }, 




2681




 





 





 





 





 





 



     into2 => { 




2682




 





 





 





 





 





 



       date => sub { ... }, 




2683




 





 





 





 





 





 



       datetime => sub { ... } 




2684




 





 





 





 





 





 



     }, 




2685




 





 





 





 





 





 



     from1 => { 




2686




 





 





 





 





 





 



       # DATE 




2687




 





 





 





 





 





 



       9 => sub { ... }, 




2688




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2689




 





 





 





 





 





 



       11 => sub { ... }, 




2690




 





 





 





 





 





 



     } 




2691




 





 





 





 





 





 



     from2 => { 




2692




 





 





 





 





 





 



       # DATE 




2693




 





 





 





 





 





 



       9 => sub { ... }, 




2694




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2695




 





 





 





 





 





 



       11 => sub { ... }, 




2696




 





 





 





 





 





 



     } 




2697




 





 





 





 





 





 



   ); 




2698




 





 





 





 





 





 



   




2699




 





 





 





 





 





 



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




2700




 





 





 





 





 





 



 This has a little complex problem. 




2701




 





 





 





 





 





 



   




2702




 





 





 





 





 





 



 In C and C you can specify 




2703




 





 





 





 





 





 



 type name as same as type name defined 




2704




 





 





 





 





 





 



 by create table, such as C or C. 




2705




 





 





 





 





 





 



   




2706




 





 





 





 





 





 



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




2707




 





 





 





 





 





 



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




2708




 





 





 





 





 





 



   




2709




 





 





 





 





 





 



 C is executed after C. 




2710




 





 





 





 





 





 



   




2711




 





 





 





 





 





 



 Type rule of C and C is enabled on the following 




2712




 





 





 





 





 





 



 column name. 




2713




 





 





 





 





 





 



   




2714




 





 





 





 





 





 



 =over 4 




2715




 





 





 





 





 





 



   




2716




 





 





 





 





 





 



 =item 1. column name 




2717




 





 





 





 





 





 



   




2718




 





 





 





 





 





 



   issue_date 




2719




 





 





 





 





 





 



   issue_datetime 




2720




 





 





 





 





 





 



   




2721




 





 





 





 





 





 



 This need C option in each method. 




2722




 





 





 





 





 





 



   




2723




 





 





 





 





 





 



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




2724




 





 





 





 





 





 



   




2725




 





 





 





 





 





 



   book.issue_date 




2726




 





 





 





 





 





 



   book.issue_datetime 




2727




 





 





 





 





 





 



   




2728




 





 





 





 





 





 



 =back 




2729




 





 





 





 





 





 



   




2730




 





 





 





 





 





 



 You get all type name used in database by C. 




2731




 





 





 





 





 





 



   




2732




 





 





 





 





 





 



   print $dbi->available_typename; 




2733




 





 





 





 





 





 



   




2734




 





 





 





 





 





 



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




2735




 





 





 





 





 





 



 C is executed after C. 




2736




 





 





 





 





 





 



 You get all data type by C. 




2737




 





 





 





 





 





 



   




2738




 





 





 





 





 





 



   print $dbi->available_datatype; 




2739




 





 





 





 





 





 



   




2740




 





 





 





 





 





 



 You can also specify multiple types at once. 




2741




 





 





 





 





 





 



   




2742




 





 





 





 





 





 



   $dbi->type_rule( 




2743




 





 





 





 





 





 



     into1 => [ 




2744




 





 





 





 





 





 



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




2745




 





 





 





 





 





 



     ], 




2746




 





 





 





 





 





 



   ); 




2747




 





 





 





 





 





 



   




2748




 





 





 





 





 





 



 =head2 update 




2749




 





 





 





 





 





 



   




2750




 





 





 





 





 





 



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




2751




 





 





 





 





 





 



   




2752




 





 





 





 





 





 



 Execute update statement. First argument is update row data. 




2753




 





 





 





 





 





 



   




2754




 





 





 





 





 





 



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




2755




 





 





 





 





 





 



 as parameter value. 




2756




 





 





 





 





 





 



   




2757




 





 





 





 





 





 



   {date => \"NOW()"} 




2758




 





 





 





 





 





 



   




2759




 





 





 





 





 





 



 B 




2760




 





 





 





 





 





 



   




2761




 





 





 





 





 





 



 C method use all of C method's options, 




2762




 





 





 





 





 





 



 and use the following new ones. 




2763




 





 





 





 





 





 



   




2764




 





 





 





 





 





 



 =over 4 




2765




 





 





 





 





 





 



   




2766




 





 





 





 





 





 



 =item prefix 




2767




 





 





 





 





 





 



   




2768




 





 





 





 





 





 



   prefix => 'or replace' 




2769




 





 





 





 





 





 



   




2770




 





 





 





 





 





 



 prefix before table name section 




2771




 





 





 





 





 





 



   




2772




 





 





 





 





 





 



   update or replace book 




2773




 





 





 





 





 





 



   




2774




 





 





 





 





 





 



 =item table 




2775




 





 





 





 





 





 



   




2776




 





 





 





 





 





 



   table => 'book' 




2777




 





 





 





 





 





 



   




2778




 





 





 





 





 





 



 Table name. 




2779




 





 





 





 





 





 



   




2780




 





 





 





 





 





 



 =item where 




2781




 





 





 





 





 





 



   




2782




 





 





 





 





 





 



 Same as C method's C option. 




2783




 





 





 





 





 





 



   




2784




 





 





 





 





 





 



 =item wrap 




2785




 





 





 





 





 





 



   




2786




 





 





 





 





 





 



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




2787




 





 





 





 





 





 



   




2788




 





 





 





 





 





 



 placeholder wrapped string. 




2789




 





 





 





 





 





 



   




2790




 





 





 





 





 





 



 If the following statement 




2791




 





 





 





 





 





 



   




2792




 





 





 





 





 





 



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




2793




 





 





 





 





 





 



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




2794




 





 





 





 





 





 



   




2795




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2796




 





 





 





 





 





 



   




2797




 





 





 





 





 





 



   update book set price =  ? + 5; 




2798




 





 





 





 





 





 



   




2799




 





 





 





 





 





 



 =item mtime 




2800




 





 





 





 





 





 



   




2801




 





 





 





 





 





 



   mtime => 'modified_time' 




2802




 





 





 





 





 





 



   




2803




 





 





 





 





 





 



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




2804




 





 





 





 





 





 



 default time format is C, which can be changed by 




2805




 





 





 





 





 





 



 C attribute. 




2806




 





 





 





 





 





 



   




2807




 





 





 





 





 





 



 =back 




2808




 





 





 





 





 





 



   




2809




 





 





 





 





 





 



 =head2 update_all 




2810




 





 





 





 





 





 



   




2811




 





 





 





 





 





 



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




2812




 





 





 





 





 





 



   




2813




 





 





 





 





 





 



 Execute update statement for all rows. 




2814




 





 





 





 





 





 



 Options is same as C method. 




2815




 





 





 





 





 





 



   




2816




 





 





 





 





 





 



 =over 4 




2817




 





 





 





 





 





 



   




2818




 





 





 





 





 





 



 =item option 




2819




 





 





 





 





 





 



   




2820




 





 





 





 





 





 



   option => { 




2821




 





 





 





 





 





 



     select => { 




2822




 





 





 





 





 





 



       append => '...' 




2823




 





 





 





 





 





 



     }, 




2824




 





 





 





 





 





 



     insert => { 




2825




 





 





 





 





 





 



       prefix => '...' 




2826




 





 





 





 





 





 



     }, 




2827




 





 





 





 





 





 



     update => { 




2828




 





 





 





 





 





 



       filter => {} 




2829




 





 





 





 





 





 



     } 




2830




 





 





 





 





 





 



   } 




2831




 





 





 





 





 





 



   




2832




 





 





 





 





 





 



 If you want to pass option to each method, 




2833




 





 





 





 





 





 



 you can use C option. 




2834




 





 





 





 





 





 



   




2835




 





 





 





 





 





 



 =over 4 




2836




 





 





 





 





 





 



   




2837




 





 





 





 





 





 



 =item select_option 




2838




 





 





 





 





 





 



   




2839




 





 





 





 





 





 



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




2840




 





 





 





 





 





 



   




2841




 





 





 





 





 





 



 select method option, 




2842




 





 





 





 





 





 



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




2843




 





 





 





 





 





 



   




2844




 





 





 





 





 





 



 =head2 show_datatype 




2845




 





 





 





 





 





 



   




2846




 





 





 





 





 





 



   $dbi->show_datatype($table); 




2847




 





 





 





 





 





 



   




2848




 





 





 





 





 





 



 Show data type of the columns of specified table. 




2849




 





 





 





 





 





 



   




2850




 





 





 





 





 





 



   book 




2851




 





 





 





 





 





 



   title: 5 




2852




 





 





 





 





 





 



   issue_date: 91 




2853




 





 





 





 





 





 



   




2854




 





 





 





 





 





 



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




2855




 





 





 





 





 





 



   




2856




 





 





 





 





 





 



 =head2 show_tables 




2857




 





 





 





 





 





 



   




2858




 





 





 





 





 





 



   $dbi->show_tables; 




2859




 





 





 





 





 





 



   




2860




 





 





 





 





 





 



 Show tables. 




2861




 





 





 





 





 





 



   




2862




 





 





 





 





 





 



 =head2 show_typename 




2863




 





 





 





 





 





 



   




2864




 





 





 





 





 





 



   $dbi->show_typename($table); 




2865




 





 





 





 





 





 



   




2866




 





 





 





 





 





 



 Show type name of the columns of specified table. 




2867




 





 





 





 





 





 



   




2868




 





 





 





 





 





 



   book 




2869




 





 





 





 





 





 



   title: varchar 




2870




 





 





 





 





 





 



   issue_date: date 




2871




 





 





 





 





 





 



   




2872




 





 





 





 





 





 



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




2873




 





 





 





 





 





 



   




2874




 





 





 





 





 





 



 =head2 values_clause 




2875




 





 





 





 





 





 



   




2876




 





 





 





 





 





 



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




2877




 





 





 





 





 





 



   




2878




 





 





 





 





 





 



 Create values clause. 




2879




 





 





 





 





 





 



   




2880




 





 





 





 





 





 



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




2881




 





 





 





 





 





 



   




2882




 





 





 





 





 





 



 You can use this in insert statement. 




2883




 





 





 





 





 





 



   




2884




 





 





 





 





 





 



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




2885




 





 





 





 





 





 



   




2886




 





 





 





 





 





 



 =head2 where 




2887




 





 





 





 





 





 



   




2888




 





 





 





 





 





 



   my $where = $dbi->where; 




2889




 





 





 





 





 





 



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




2890




 





 





 





 





 





 



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




2891




 





 





 





 





 





 



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




2892




 





 





 





 





 





 



   




2893




 





 





 





 





 





 



 Create a new L object. 




2894




 





 





 





 





 





 



 See L to know how to create where clause. 




2895




 





 





 





 





 





 



   




2896




 





 





 





 





 





 



 =head1 ENVIRONMENTAL VARIABLES 




2897




 





 





 





 





 





 



   




2898




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG 




2899




 





 





 





 





 





 



   




2900




 





 





 





 





 





 



 If environment variable C is set to true, 




2901




 





 





 





 





 





 



 executed SQL and bind values are printed to STDERR. 




2902




 





 





 





 





 





 



   




2903




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG_ENCODING 




2904




 





 





 





 





 





 



   




2905




 





 





 





 





 





 



 DEBUG output encoding. Default to UTF-8. 




2906




 





 





 





 





 





 



   




2907




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION 




2908




 





 





 





 





 





 



   




2909




 





 





 





 





 





 



   $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25'; 




2910




 





 





 





 





 





 



   




2911




 





 





 





 





 





 



 Suppress deprecation warnings before specified version. 




2912




 





 





 





 





 





 



   




2913




 





 





 





 





 





 



 =head1 DEPRECATED FUNCTIONALITY 




2914




 





 





 





 





 





 



   




2915




 





 





 





 





 





 



 L 




2916




 





 





 





 





 





 



   




2917




 





 





 





 





 





 



   # Methods 




2918




 





 





 





 





 





 



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




2919




 





 





 





 





 





 



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




2920




 





 





 





 





 





 



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




2921




 





 





 





 





 





 



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




2922




 





 





 





 





 





 



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




2923




 





 





 





 





 





 



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




2924




 





 





 





 





 





 



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




2925




 





 





 





 





 





 



   




2926




 





 





 





 





 





 



 L 




2927




 





 





 





 





 





 



    




2928




 





 





 





 





 





 



   # Options 




2929




 





 





 





 





 





 



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




2930




 





 





 





 





 





 



   




2931




 





 





 





 





 





 



 L 




2932




 





 





 





 





 





 



   




2933




 





 





 





 





 





 



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




2934




 





 





 





 





 





 



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




2935




 





 





 





 





 





 



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




2936




 





 





 





 





 





 



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




2937




 





 





 





 





 





 



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




2938




 





 





 





 





 





 



   




2939




 





 





 





 





 





 



 =head1 BACKWARDS COMPATIBILITY POLICY 




2940




 





 





 





 





 





 



   




2941




 





 





 





 





 





 



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




2942




 





 





 





 





 





 



 DEPRECATED feature is removed after C, 




2943




 





 





 





 





 





 



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




2944




 





 





 





 





 





 



 I extend one year each time he tell me it. 




2945




 





 





 





 





 





 



   




2946




 





 





 





 





 





 



 DEPRECATION warnings can be suppressed by C 




2947




 





 





 





 





 





 



 environment variable. 




2948




 





 





 





 





 





 



   




2949




 





 





 





 





 





 



 EXPERIMENTAL features will be changed or deleted without warnings. 




2950




 





 





 





 





 





 



   




2951




 





 





 





 





 





 



 =head1 BUGS 




2952




 





 





 





 





 





 



   




2953




 





 





 





 





 





 



 Please tell me bugs if you find bug. 




2954




 





 





 





 





 





 



   




2955




 





 





 





 





 





 



 C<<  >> 




2956




 





 





 





 





 





 



   




2957




 





 





 





 





 





 



 L 




2958




 





 





 





 





 





 



   




2959




 





 





 





 





 





 



 =head1 AUTHOR 




2960




 





 





 





 





 





 



   




2961




 





 





 





 





 





 



 Yuki Kimoto, C<<  >> 




2962




 





 





 





 





 





 



   




2963




 





 





 





 





 





 



 =head1 COPYRIGHT & LICENSE 




2964




 





 





 





 





 





 



   




2965




 





 





 





 





 





 



 Copyright 2009-2019 Yuki Kimoto, all rights reserved. 




2966




 





 





 





 





 





 



   




2967




 





 





 





 





 





 



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




2968




 





 





 





 





 





 



 under the same terms as Perl itself. 




2969




 





 





 





 





 





 



   




2970




 





 





 





 





 





 



 =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. 




2223




 





 





 





 





 





 



   




2224




 





 





 





 





 





 



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




2225




 





 





 





 





 





 



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




2226




 





 





 





 





 





 



   




2227




 





 





 





 





 





 



   # Same 




2228




 





 





 





 





 





 



   $dbi->execute( 




2229




 





 





 





 





 





 



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




2230




 





 





 





 





 





 



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




2231




 





 





 





 





 





 



   




2232




 





 





 





 





 





 



 =item table_alias 




2233




 





 





 





 





 





 



   




2234




 





 





 





 





 





 



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




2235




 





 





 





 





 





 



   




2236




 





 





 





 





 





 



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




2237




 





 





 





 





 





 



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




2238




 





 





 





 





 





 



 on alias table name. 




2239




 





 





 





 





 





 



   




2240




 





 





 





 





 





 



 =item type_rule_off 




2241




 





 





 





 





 





 



   




2242




 





 





 





 





 





 



   type_rule_off => 1 




2243




 





 





 





 





 





 



   




2244




 





 





 





 





 





 



 Turn C and C type rule off. 




2245




 





 





 





 





 





 



   




2246




 





 





 





 





 





 



 =item type_rule1_off 




2247




 





 





 





 





 





 



   




2248




 





 





 





 





 





 



   type_rule1_off => 1 




2249




 





 





 





 





 





 



   




2250




 





 





 





 





 





 



 Turn C type rule off. 




2251




 





 





 





 





 





 



   




2252




 





 





 





 





 





 



 =item type_rule2_off 




2253




 





 





 





 





 





 



   




2254




 





 





 





 





 





 



   type_rule2_off => 1 




2255




 





 





 





 





 





 



   




2256




 





 





 





 





 





 



 Turn C type rule off. 




2257




 





 





 





 





 





 



   




2258




 





 





 





 





 





 



 =head2 get_column_info 




2259




 





 





 





 





 





 



   




2260




 





 





 





 





 





 



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




2261




 





 





 





 





 





 



   




2262




 





 





 





 





 





 



 get column information except for one which match C pattern. 




2263




 





 





 





 





 





 



   




2264




 





 





 





 





 





 



   [ 




2265




 





 





 





 





 





 



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




2266




 





 





 





 





 





 



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




2267




 





 





 





 





 





 



   ] 




2268




 





 





 





 





 





 



   




2269




 





 





 





 





 





 



 =head2 get_table_info 




2270




 





 





 





 





 





 



   




2271




 





 





 





 





 





 



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




2272




 





 





 





 





 





 



   




2273




 





 





 





 





 





 



 get table information except for one which match C pattern. 




2274




 





 





 





 





 





 



   




2275




 





 





 





 





 





 



   [ 




2276




 





 





 





 





 





 



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




2277




 





 





 





 





 





 



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




2278




 





 





 





 





 





 



   ] 




2279




 





 





 





 





 





 



   




2280




 





 





 





 





 





 



 You can set this value to C. 




2281




 





 





 





 





 





 



   




2282




 





 





 





 





 





 



 =head2 insert 




2283




 





 





 





 





 





 



   




2284




 





 





 





 





 





 



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




2285




 





 





 





 





 





 



   




2286




 





 





 





 





 





 



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




2287




 





 





 





 





 





 



 affected row count. 




2288




 





 





 





 





 





 



   




2289




 





 





 





 





 





 



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




2290




 





 





 





 





 





 



 as parameter value. 




2291




 





 





 





 





 





 



   




2292




 





 





 





 





 





 



   {date => \"NOW()"} 




2293




 





 





 





 





 





 



   




2294




 





 





 





 





 





 



 You can pass multiple parameters, this is very fast. 




2295




 





 





 





 





 





 



   




2296




 





 





 





 





 





 



   $dbi->insert( 




2297




 





 





 





 





 





 



     [ 




2298




 





 





 





 





 





 



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




2299




 





 





 





 





 





 



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




2300




 





 





 





 





 





 



     ], 




2301




 





 





 





 





 





 



     table  => 'book' 




2302




 





 





 





 





 





 



   ); 




2303




 





 





 





 





 





 



   




2304




 





 





 





 





 





 



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




2305




 





 





 





 





 





 



 and only first parameter is used to create sql. 




2306




 





 





 





 





 





 



   




2307




 





 





 





 





 





 



 B 




2308




 





 





 





 





 





 



   




2309




 





 





 





 





 





 



 C method use all of C method's options, 




2310




 





 





 





 





 





 



 and use the following new ones. 




2311




 





 





 





 





 





 



   




2312




 





 





 





 





 





 



 =over 4 




2313




 





 





 





 





 





 



   




2314




 





 





 





 





 





 



 =item bulk_insert 




2315




 





 





 





 





 





 



   




2316




 





 





 





 





 





 



   bulk_insert => 1 




2317




 





 





 





 





 





 



   




2318




 





 





 





 





 





 



 bulk insert is executed if database support bulk insert and  




2319




 





 





 





 





 





 



 multiple parameters is passed to C. 




2320




 





 





 





 





 





 



 The SQL like the following one is executed. 




2321




 





 





 





 





 





 



   




2322




 





 





 





 





 





 



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




2323




 





 





 





 





 





 



   




2324




 





 





 





 





 





 



 =item ctime 




2325




 





 





 





 





 





 



   




2326




 





 





 





 





 





 



   ctime => 'created_time' 




2327




 





 





 





 





 





 



   




2328




 





 





 





 





 





 



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




2329




 





 





 





 





 





 



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




2330




 





 





 





 





 





 



 C attribute. 




2331




 





 





 





 





 





 



   




2332




 





 





 





 





 





 



 =item prefix 




2333




 





 





 





 





 





 



   




2334




 





 





 





 





 





 



   prefix => 'or replace' 




2335




 





 





 





 





 





 



   




2336




 





 





 





 





 





 



 prefix before table name section 




2337




 





 





 





 





 





 



   




2338




 





 





 





 





 





 



   insert or replace into book 




2339




 





 





 





 





 





 



   




2340




 





 





 





 





 





 



 =item table 




2341




 





 





 





 





 





 



   




2342




 





 





 





 





 





 



   table => 'book' 




2343




 





 





 





 





 





 



   




2344




 





 





 





 





 





 



 Table name. 




2345




 





 





 





 





 





 



   




2346




 





 





 





 





 





 



 =item mtime 




2347




 





 





 





 





 





 



   




2348




 





 





 





 





 





 



 This option is same as C method C option. 




2349




 





 





 





 





 





 



   




2350




 





 





 





 





 





 



 =item wrap 




2351




 





 





 





 





 





 



   




2352




 





 





 





 





 





 



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




2353




 





 





 





 





 





 



   




2354




 





 





 





 





 





 



 placeholder wrapped string. 




2355




 





 





 





 





 





 



   




2356




 





 





 





 





 





 



 If the following statement 




2357




 





 





 





 





 





 



   




2358




 





 





 





 





 





 



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




2359




 





 





 





 





 





 



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




2360




 





 





 





 





 





 



   




2361




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2362




 





 





 





 





 





 



   




2363




 





 





 





 





 





 



   insert into book price values ( ? + 5 ); 




2364




 





 





 





 





 





 



   




2365




 





 





 





 





 





 



 =back 




2366




 





 





 





 





 





 



   




2367




 





 





 





 





 





 



 =over 4 




2368




 





 





 





 





 





 



   




2369




 





 





 





 





 





 



 =head2 include_model 




2370




 





 





 





 





 





 



   




2371




 





 





 





 





 





 



   $dbi->include_model('MyModel'); 




2372




 





 





 





 





 





 



   




2373




 





 





 





 





 





 



 Include models from specified namespace, 




2374




 





 





 





 





 





 



 the following layout is needed to include models. 




2375




 





 





 





 





 





 



   




2376




 





 





 





 





 





 



   lib / MyModel.pm 




2377




 





 





 





 





 





 



       / MyModel / book.pm 




2378




 





 





 





 





 





 



                 / company.pm 




2379




 





 





 





 





 





 



   




2380




 





 





 





 





 





 



 Name space module, extending L. 




2381




 





 





 





 





 





 



   




2382




 





 





 





 





 





 



 B 




2383




 





 





 





 





 





 



   




2384




 





 





 





 





 





 



   package MyModel; 




2385




 





 





 





 





 





 



   use DBIx::Custom::Model -base; 




2386




 





 





 





 





 





 



    




2387




 





 





 





 





 





 



   1; 




2388




 





 





 





 





 





 



   




2389




 





 





 





 





 





 



 Model modules, extending name space module. 




2390




 





 





 





 





 





 



   




2391




 





 





 





 





 





 



 B 




2392




 





 





 





 





 





 



   




2393




 





 





 





 





 





 



   package MyModel::book; 




2394




 





 





 





 





 





 



   use MyModel -base; 




2395




 





 





 





 





 





 



    




2396




 





 





 





 





 





 



   1; 




2397




 





 





 





 





 





 



   




2398




 





 





 





 





 





 



 B 




2399




 





 





 





 





 





 



   




2400




 





 





 





 





 





 



   package MyModel::company; 




2401




 





 





 





 





 





 



   use MyModel -base; 




2402




 





 





 





 





 





 



    




2403




 





 





 





 





 





 



   1; 




2404




 





 





 





 





 





 



    




2405




 





 





 





 





 





 



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




2406




 





 





 





 





 





 



   




2407




 





 





 





 





 





 



 You can get model object by C. 




2408




 





 





 





 





 





 



   




2409




 





 





 





 





 





 



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




2410




 





 





 





 





 





 



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




2411




 





 





 





 





 





 



   




2412




 





 





 





 





 





 



 You can include full-qualified table name like C 




2413




 





 





 





 





 





 



   




2414




 





 





 





 





 





 



   lib / MyModel.pm 




2415




 





 





 





 





 





 



       / MyModel / main / book.pm 




2416




 





 





 





 





 





 



                        / company.pm 




2417




 





 





 





 





 





 



   




2418




 





 





 





 





 





 



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




2419




 





 





 





 





 





 



   




2420




 





 





 





 





 





 



 See L to know model features. 




2421




 





 





 





 





 





 



   




2422




 





 





 





 





 





 



 =head2 like_value 




2423




 





 





 





 





 





 



   




2424




 





 





 





 





 





 



   my $like_value = $dbi->like_value 




2425




 





 





 





 





 





 



   




2426




 





 





 





 





 





 



 Code reference which return a value for the like value. 




2427




 





 





 





 





 





 



   




2428




 





 





 





 





 





 



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




2429




 





 





 





 





 





 



   




2430




 





 





 





 





 





 



 =head2 mapper 




2431




 





 





 





 





 





 



   




2432




 





 





 





 





 





 



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




2433




 





 





 





 





 





 



   




2434




 





 





 





 





 





 



 Create a new L object. 




2435




 





 





 





 





 





 



   




2436




 





 





 





 





 





 



 =head2 merge_param 




2437




 





 





 





 





 





 



   




2438




 





 





 





 





 





 



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




2439




 





 





 





 





 





 



   




2440




 





 





 





 





 





 



 Merge parameters. The following new parameter is created. 




2441




 





 





 





 





 





 



   




2442




 





 





 





 





 





 



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




2443




 





 





 





 





 





 



   




2444




 





 





 





 





 





 



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




2445




 





 





 





 





 





 



   




2446




 





 





 





 





 





 



 =head2 model 




2447




 





 





 





 





 





 



   




2448




 





 





 





 





 





 



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




2449




 





 





 





 





 





 



   




2450




 





 





 





 





 





 



 Get a L object 




2451




 





 





 





 





 





 



 create by C or C 




2452




 





 





 





 





 





 



   




2453




 





 





 





 





 





 



 =head2 mycolumn 




2454




 





 





 





 





 





 



   




2455




 





 





 





 





 





 



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




2456




 





 





 





 





 





 



   




2457




 





 





 





 





 





 



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




2458




 





 





 





 





 





 



   




2459




 





 





 





 





 





 



   book.author as author, 




2460




 





 





 





 





 





 



   book.title as title 




2461




 





 





 





 





 





 



   




2462




 





 





 





 





 





 



 =head2 new 




2463




 





 





 





 





 





 



   




2464




 





 





 





 





 





 



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




2465




 





 





 





 





 





 



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




2466




 





 





 





 





 





 



     user => 'ken', 




2467




 





 





 





 





 





 



     password => '!LFKD%$&', 




2468




 





 





 





 





 





 



     option => {mysql_enable_utf8 => 1} 




2469




 





 





 





 





 





 



   ); 




2470




 





 





 





 





 





 



   




2471




 





 





 





 





 





 



 Create a new L object. 




2472




 





 





 





 





 





 



   




2473




 





 





 





 





 





 



 =head2 not_exists 




2474




 





 





 





 





 





 



   




2475




 





 





 





 





 





 



   my $not_exists = $dbi->not_exists; 




2476




 





 





 





 





 





 



   




2477




 





 





 





 





 





 



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




2478




 





 





 





 





 





 



 This is used in C of L . 




2479




 





 





 





 





 





 



   




2480




 





 





 





 





 





 



 =head2 order 




2481




 





 





 





 





 





 



   




2482




 





 





 





 





 





 



   my $order = $dbi->order; 




2483




 





 





 





 





 





 



   




2484




 





 





 





 





 





 



 Create a new L object. 




2485




 





 





 





 





 





 



   




2486




 





 





 





 





 





 



 =head2 q 




2487




 





 





 





 





 





 



   




2488




 





 





 





 





 





 



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




2489




 





 





 





 





 





 



   




2490




 





 





 





 





 





 



 Quote string by value of C. 




2491




 





 





 





 





 





 



   




2492




 





 





 





 





 





 



 =head2 register_filter 




2493




 





 





 





 





 





 



   




2494




 





 





 





 





 





 



   $dbi->register_filter( 




2495




 





 





 





 





 





 



     # Time::Piece object to database DATE format 




2496




 





 





 





 





 





 



     tp_to_date => sub { 




2497




 





 





 





 





 





 



       my $tp = shift; 




2498




 





 





 





 





 





 



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




2499




 





 





 





 





 





 



     }, 




2500




 





 





 





 





 





 



     # database DATE format to Time::Piece object 




2501




 





 





 





 





 





 



     date_to_tp => sub { 




2502




 





 





 





 





 





 



       my $date = shift; 




2503




 





 





 





 





 





 



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




2504




 





 





 





 





 





 



     } 




2505




 





 





 





 





 





 



   ); 




2506




 





 





 





 





 





 



    




2507




 





 





 





 





 





 



 Register filters, used by C option of many methods. 




2508




 





 





 





 





 





 



   




2509




 





 





 





 





 





 



 =head2 select 




2510




 





 





 





 





 





 



   




2511




 





 





 





 





 





 



   my $result = $dbi->select( 




2512




 





 





 





 





 





 



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




2513




 





 





 





 





 





 



     table  => 'book', 




2514




 





 





 





 





 





 



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




2515




 





 





 





 





 





 



   ); 




2516




 





 





 





 





 





 



    




2517




 





 





 





 





 





 



 Execute select statement. 




2518




 





 





 





 





 





 



   




2519




 





 





 





 





 





 



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




2520




 





 





 





 





 





 



   




2521




 





 





 





 





 





 



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




2522




 





 





 





 





 





 



   




2523




 





 





 





 





 





 



 B 




2524




 





 





 





 





 





 



   




2525




 





 





 





 





 





 



 C method use all of C method's options, 




2526




 





 





 





 





 





 



 and use the following new ones. 




2527




 





 





 





 





 





 



   




2528




 





 





 





 





 





 



 =over 4 




2529




 





 





 





 





 





 



   




2530




 





 





 





 





 





 



 =item column 




2531




 





 





 





 





 





 



    




2532




 





 





 





 





 





 



   column => 'author' 




2533




 





 





 





 





 





 



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




2534




 





 





 





 





 





 



   




2535




 





 





 





 





 





 



 Column clause. 




2536




 





 





 





 





 





 



    




2537




 





 





 





 





 





 



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




2538




 





 





 





 





 





 



   




2539




 





 





 





 





 





 



   column => '*' 




2540




 





 





 





 





 





 



   




2541




 





 





 





 





 





 



 You can specify hash of array reference. 




2542




 





 





 





 





 





 



   




2543




 





 





 





 





 





 



   column => [ 




2544




 





 





 





 





 





 



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




2545




 





 





 





 





 





 



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




2546




 





 





 





 





 





 



   ] 




2547




 





 





 





 





 





 



   




2548




 





 





 





 





 





 



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




2549




 





 





 





 





 





 



   




2550




 





 





 





 





 





 



   book.author as "book.author", 




2551




 





 





 





 





 





 



   book.title as "book.title", 




2552




 





 





 





 





 





 



   person.name as "person.name", 




2553




 





 





 





 





 





 



   person.age as "person.age" 




2554




 





 





 





 





 





 



   




2555




 





 





 





 





 





 



 You can specify own column by C<__MY__>. 




2556




 





 





 





 





 





 



   




2557




 





 





 





 





 





 



   column => [ 




2558




 





 





 





 





 





 



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




2559




 





 





 





 





 





 



   ] 




2560




 





 





 





 





 





 



   




2561




 





 





 





 





 





 



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




2562




 





 





 





 





 





 



   




2563




 





 





 





 





 





 



   book.author as "author", 




2564




 





 





 





 





 





 



   book.title as "title", 




2565




 





 





 





 





 





 



   




2566




 





 





 





 





 





 



 C<__MY__> can be changed by C attribute. 




2567




 





 





 





 





 





 



   




2568




 





 





 





 





 





 



 =item param 




2569




 





 





 





 





 





 



   




2570




 





 





 





 





 





 



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




2571




 





 





 





 





 





 



   




2572




 





 





 





 





 





 



 Parameter shown before where clause. 




2573




 





 





 





 





 





 



    




2574




 





 





 





 





 





 



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




2575




 





 





 





 





 





 



 you can pass parameter by C option. 




2576




 





 





 





 





 





 



   




2577




 





 





 





 





 





 



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




2578




 





 





 





 





 





 



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




2579




 





 





 





 





 





 



   




2580




 





 





 





 





 





 



 =item prefix 




2581




 





 





 





 





 





 



   




2582




 





 





 





 





 





 



   prefix => 'SQL_CALC_FOUND_ROWS' 




2583




 





 





 





 





 





 



   




2584




 





 





 





 





 





 



 Prefix of column clause 




2585




 





 





 





 





 





 



   




2586




 





 





 





 





 





 



   select SQL_CALC_FOUND_ROWS title, author from book; 




2587




 





 





 





 





 





 



   




2588




 





 





 





 





 





 



 =item join 




2589




 





 





 





 





 





 



   




2590




 





 





 





 





 





 



   join => [ 




2591




 





 





 





 





 





 



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




2592




 





 





 





 





 





 



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




2593




 





 





 





 





 





 



   ] 




2594




 





 





 





 





 





 



        




2595




 





 





 





 





 





 



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




2596




 





 





 





 





 





 



 join clauses needed when SQL is created is used automatically. 




2597




 





 





 





 





 





 



   




2598




 





 





 





 





 





 



   $dbi->select( 




2599




 





 





 





 





 





 



     table => 'book', 




2600




 





 





 





 





 





 



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




2601




 





 





 





 





 





 



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




2602




 





 





 





 





 





 



     join => [ 




2603




 





 





 





 





 





 



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




2604




 





 





 





 





 





 



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




2605




 





 





 





 





 





 



     ] 




2606




 





 





 





 





 





 



   ); 




2607




 





 





 





 





 





 



   




2608




 





 





 





 





 





 



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




2609




 





 





 





 





 





 



 the following SQL is created 




2610




 





 





 





 





 





 



   




2611




 





 





 





 





 





 



   select company.location_id as location_id 




2612




 





 





 





 





 





 



   from book 




2613




 





 





 





 





 





 



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




2614




 





 





 





 





 





 



   where company.name = ?; 




2615




 





 





 





 





 





 



   




2616




 





 





 





 





 





 



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




2617




 





 





 





 





 





 



 the join clause correctly. 




2618




 





 





 





 





 





 



   




2619




 





 





 





 





 





 



   $dbi->select( 




2620




 





 





 





 





 





 



     table => 'book', 




2621




 





 





 





 





 





 



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




2622




 





 





 





 





 





 



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




2623




 





 





 





 





 





 



     join => [ 




2624




 





 





 





 





 





 



       { 




2625




 





 





 





 





 





 



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




2626




 





 





 





 





 





 



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




2627




 





 





 





 





 





 



       } 




2628




 





 





 





 





 





 



     ] 




2629




 





 





 





 





 





 



   ); 




2630




 





 





 





 





 





 



   




2631




 





 





 





 





 





 



 =item table 




2632




 





 





 





 





 





 



   




2633




 





 





 





 





 





 



   table => 'book' 




2634




 





 





 





 





 





 



   




2635




 





 





 





 





 





 



 Table name. 




2636




 





 





 





 





 





 



   




2637




 





 





 





 





 





 



 =item where 




2638




 





 





 





 





 





 



    




2639




 





 





 





 





 





 



   # (1) Hash reference 




2640




 





 





 





 





 





 



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




2641




 





 





 





 





 





 



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




2642




 





 





 





 





 





 



    




2643




 





 





 





 





 





 



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




2644




 





 





 





 





 





 



   where => $dbi->where( 




2645




 





 





 





 





 





 



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




2646




 





 





 





 





 





 



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




2647




 





 





 





 





 





 



   ) 




2648




 





 





 





 





 





 



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




2649




 





 





 





 





 





 



    




2650




 





 





 





 





 





 



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




2651




 





 





 





 





 





 



   where => [ 




2652




 





 





 





 





 





 



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




2653




 





 





 





 





 





 



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




2654




 





 





 





 





 





 



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




2655




 





 





 





 





 





 



   ] 




2656




 





 





 





 





 





 



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




2657




 





 





 





 





 





 



    




2658




 





 





 





 





 





 



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




2659




 





 





 





 





 





 



   where => [ 




2660




 





 





 





 





 





 



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




2661




 





 





 





 





 





 



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




2662




 





 





 





 





 





 



   ] 




2663




 





 





 





 





 





 



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




2664




 





 





 





 





 





 



    




2665




 





 





 





 





 





 



   # (5) String 




2666




 





 





 





 





 





 



   where => 'title is null' 




2667




 





 





 





 





 





 



   #  -> where title is null 




2668




 





 





 





 





 





 



   




2669




 





 





 





 





 





 



 Where clause. 




2670




 





 





 





 





 





 



 See also L to know how to create where clause. 




2671




 





 





 





 





 





 



    




2672




 





 





 





 





 





 



 =back 




2673




 





 





 





 





 





 



   




2674




 





 





 





 





 





 



 =head2 type_rule 




2675




 





 





 





 





 





 



   




2676




 





 





 





 





 





 



   $dbi->type_rule( 




2677




 





 





 





 





 





 



     into1 => { 




2678




 





 





 





 





 





 



       date => sub { ... }, 




2679




 





 





 





 





 





 



       datetime => sub { ... } 




2680




 





 





 





 





 





 



     }, 




2681




 





 





 





 





 





 



     into2 => { 




2682




 





 





 





 





 





 



       date => sub { ... }, 




2683




 





 





 





 





 





 



       datetime => sub { ... } 




2684




 





 





 





 





 





 



     }, 




2685




 





 





 





 





 





 



     from1 => { 




2686




 





 





 





 





 





 



       # DATE 




2687




 





 





 





 





 





 



       9 => sub { ... }, 




2688




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2689




 





 





 





 





 





 



       11 => sub { ... }, 




2690




 





 





 





 





 





 



     } 




2691




 





 





 





 





 





 



     from2 => { 




2692




 





 





 





 





 





 



       # DATE 




2693




 





 





 





 





 





 



       9 => sub { ... }, 




2694




 





 





 





 





 





 



       # DATETIME or TIMESTAMP 




2695




 





 





 





 





 





 



       11 => sub { ... }, 




2696




 





 





 





 





 





 



     } 




2697




 





 





 





 





 





 



   ); 




2698




 





 





 





 





 





 



   




2699




 





 





 





 





 





 



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




2700




 





 





 





 





 





 



 This has a little complex problem. 




2701




 





 





 





 





 





 



   




2702




 





 





 





 





 





 



 In C and C you can specify 




2703




 





 





 





 





 





 



 type name as same as type name defined 




2704




 





 





 





 





 





 



 by create table, such as C or C. 




2705




 





 





 





 





 





 



   




2706




 





 





 





 





 





 



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




2707




 





 





 





 





 





 



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




2708




 





 





 





 





 





 



   




2709




 





 





 





 





 





 



 C is executed after C. 




2710




 





 





 





 





 





 



   




2711




 





 





 





 





 





 



 Type rule of C and C is enabled on the following 




2712




 





 





 





 





 





 



 column name. 




2713




 





 





 





 





 





 



   




2714




 





 





 





 





 





 



 =over 4 




2715




 





 





 





 





 





 



   




2716




 





 





 





 





 





 



 =item 1. column name 




2717




 





 





 





 





 





 



   




2718




 





 





 





 





 





 



   issue_date 




2719




 





 





 





 





 





 



   issue_datetime 




2720




 





 





 





 





 





 



   




2721




 





 





 





 





 





 



 This need C option in each method. 




2722




 





 





 





 





 





 



   




2723




 





 





 





 





 





 



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




2724




 





 





 





 





 





 



   




2725




 





 





 





 





 





 



   book.issue_date 




2726




 





 





 





 





 





 



   book.issue_datetime 




2727




 





 





 





 





 





 



   




2728




 





 





 





 





 





 



 =back 




2729




 





 





 





 





 





 



   




2730




 





 





 





 





 





 



 You get all type name used in database by C. 




2731




 





 





 





 





 





 



   




2732




 





 





 





 





 





 



   print $dbi->available_typename; 




2733




 





 





 





 





 





 



   




2734




 





 





 





 





 





 



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




2735




 





 





 





 





 





 



 C is executed after C. 




2736




 





 





 





 





 





 



 You get all data type by C. 




2737




 





 





 





 





 





 



   




2738




 





 





 





 





 





 



   print $dbi->available_datatype; 




2739




 





 





 





 





 





 



   




2740




 





 





 





 





 





 



 You can also specify multiple types at once. 




2741




 





 





 





 





 





 



   




2742




 





 





 





 





 





 



   $dbi->type_rule( 




2743




 





 





 





 





 





 



     into1 => [ 




2744




 





 





 





 





 





 



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




2745




 





 





 





 





 





 



     ], 




2746




 





 





 





 





 





 



   ); 




2747




 





 





 





 





 





 



   




2748




 





 





 





 





 





 



 =head2 update 




2749




 





 





 





 





 





 



   




2750




 





 





 





 





 





 



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




2751




 





 





 





 





 





 



   




2752




 





 





 





 





 





 



 Execute update statement. First argument is update row data. 




2753




 





 





 





 





 





 



   




2754




 





 





 





 





 





 



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




2755




 





 





 





 





 





 



 as parameter value. 




2756




 





 





 





 





 





 



   




2757




 





 





 





 





 





 



   {date => \"NOW()"} 




2758




 





 





 





 





 





 



   




2759




 





 





 





 





 





 



 B 




2760




 





 





 





 





 





 



   




2761




 





 





 





 





 





 



 C method use all of C method's options, 




2762




 





 





 





 





 





 



 and use the following new ones. 




2763




 





 





 





 





 





 



   




2764




 





 





 





 





 





 



 =over 4 




2765




 





 





 





 





 





 



   




2766




 





 





 





 





 





 



 =item prefix 




2767




 





 





 





 





 





 



   




2768




 





 





 





 





 





 



   prefix => 'or replace' 




2769




 





 





 





 





 





 



   




2770




 





 





 





 





 





 



 prefix before table name section 




2771




 





 





 





 





 





 



   




2772




 





 





 





 





 





 



   update or replace book 




2773




 





 





 





 





 





 



   




2774




 





 





 





 





 





 



 =item table 




2775




 





 





 





 





 





 



   




2776




 





 





 





 





 





 



   table => 'book' 




2777




 





 





 





 





 





 



   




2778




 





 





 





 





 





 



 Table name. 




2779




 





 





 





 





 





 



   




2780




 





 





 





 





 





 



 =item where 




2781




 





 





 





 





 





 



   




2782




 





 





 





 





 





 



 Same as C method's C option. 




2783




 





 





 





 





 





 



   




2784




 





 





 





 





 





 



 =item wrap 




2785




 





 





 





 





 





 



   




2786




 





 





 





 





 





 



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




2787




 





 





 





 





 





 



   




2788




 





 





 





 





 





 



 placeholder wrapped string. 




2789




 





 





 





 





 





 



   




2790




 





 





 





 





 





 



 If the following statement 




2791




 





 





 





 





 





 



   




2792




 





 





 





 





 





 



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




2793




 





 





 





 





 





 



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




2794




 





 





 





 





 





 



   




2795




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2796




 





 





 





 





 





 



   




2797




 





 





 





 





 





 



   update book set price =  ? + 5; 




2798




 





 





 





 





 





 



   




2799




 





 





 





 





 





 



 =item mtime 




2800




 





 





 





 





 





 



   




2801




 





 





 





 





 





 



   mtime => 'modified_time' 




2802




 





 





 





 





 





 



   




2803




 





 





 





 





 





 



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




2804




 





 





 





 





 





 



 default time format is C, which can be changed by 




2805




 





 





 





 





 





 



 C attribute. 




2806




 





 





 





 





 





 



   




2807




 





 





 





 





 





 



 =back 




2808




 





 





 





 





 





 



   




2809




 





 





 





 





 





 



 =head2 update_all 




2810




 





 





 





 





 





 



   




2811




 





 





 





 





 





 



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




2812




 





 





 





 





 





 



   




2813




 





 





 





 





 





 



 Execute update statement for all rows. 




2814




 





 





 





 





 





 



 Options is same as C method. 




2815




 





 





 





 





 





 



   




2816




 





 





 





 





 





 



 =over 4 




2817




 





 





 





 





 





 



   




2818




 





 





 





 





 





 



 =item option 




2819




 





 





 





 





 





 



   




2820




 





 





 





 





 





 



   option => { 




2821




 





 





 





 





 





 



     select => { 




2822




 





 





 





 





 





 



       append => '...' 




2823




 





 





 





 





 





 



     }, 




2824




 





 





 





 





 





 



     insert => { 




2825




 





 





 





 





 





 



       prefix => '...' 




2826




 





 





 





 





 





 



     }, 




2827




 





 





 





 





 





 



     update => { 




2828




 





 





 





 





 





 



       filter => {} 




2829




 





 





 





 





 





 



     } 




2830




 





 





 





 





 





 



   } 




2831




 





 





 





 





 





 



   




2832




 





 





 





 





 





 



 If you want to pass option to each method, 




2833




 





 





 





 





 





 



 you can use C option. 




2834




 





 





 





 





 





 



   




2835




 





 





 





 





 





 



 =over 4 




2836




 





 





 





 





 





 



   




2837




 





 





 





 





 





 



 =item select_option 




2838




 





 





 





 





 





 



   




2839




 





 





 





 





 





 



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




2840




 





 





 





 





 





 



   




2841




 





 





 





 





 





 



 select method option, 




2842




 





 





 





 





 





 



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




2843




 





 





 





 





 





 



   




2844




 





 





 





 





 





 



 =head2 show_datatype 




2845




 





 





 





 





 





 



   




2846




 





 





 





 





 





 



   $dbi->show_datatype($table); 




2847




 





 





 





 





 





 



   




2848




 





 





 





 





 





 



 Show data type of the columns of specified table. 




2849




 





 





 





 





 





 



   




2850




 





 





 





 





 





 



   book 




2851




 





 





 





 





 





 



   title: 5 




2852




 





 





 





 





 





 



   issue_date: 91 




2853




 





 





 





 





 





 



   




2854




 





 





 





 





 





 



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




2855




 





 





 





 





 





 



   




2856




 





 





 





 





 





 



 =head2 show_tables 




2857




 





 





 





 





 





 



   




2858




 





 





 





 





 





 



   $dbi->show_tables; 




2859




 





 





 





 





 





 



   




2860




 





 





 





 





 





 



 Show tables. 




2861




 





 





 





 





 





 



   




2862




 





 





 





 





 





 



 =head2 show_typename 




2863




 





 





 





 





 





 



   




2864




 





 





 





 





 





 



   $dbi->show_typename($table); 




2865




 





 





 





 





 





 



   




2866




 





 





 





 





 





 



 Show type name of the columns of specified table. 




2867




 





 





 





 





 





 



   




2868




 





 





 





 





 





 



   book 




2869




 





 





 





 





 





 



   title: varchar 




2870




 





 





 





 





 





 



   issue_date: date 




2871




 





 





 





 





 





 



   




2872




 





 





 





 





 





 



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




2873




 





 





 





 





 





 



   




2874




 





 





 





 





 





 



 =head2 values_clause 




2875




 





 





 





 





 





 



   




2876




 





 





 





 





 





 



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




2877




 





 





 





 





 





 



   




2878




 





 





 





 





 





 



 Create values clause. 




2879




 





 





 





 





 





 



   




2880




 





 





 





 





 





 



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




2881




 





 





 





 





 





 



   




2882




 





 





 





 





 





 



 You can use this in insert statement. 




2883




 





 





 





 





 





 



   




2884




 





 





 





 





 





 



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




2885




 





 





 





 





 





 



   




2886




 





 





 





 





 





 



 =head2 where 




2887




 





 





 





 





 





 



   




2888




 





 





 





 





 





 



   my $where = $dbi->where; 




2889




 





 





 





 





 





 



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




2890




 





 





 





 





 





 



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




2891




 





 





 





 





 





 



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




2892




 





 





 





 





 





 



   




2893




 





 





 





 





 





 



 Create a new L object. 




2894




 





 





 





 





 





 



 See L to know how to create where clause. 




2895




 





 





 





 





 





 



   




2896




 





 





 





 





 





 



 =head1 ENVIRONMENTAL VARIABLES 




2897




 





 





 





 





 





 



   




2898




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG 




2899




 





 





 





 





 





 



   




2900




 





 





 





 





 





 



 If environment variable C is set to true, 




2901




 





 





 





 





 





 



 executed SQL and bind values are printed to STDERR. 




2902




 





 





 





 





 





 



   




2903




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG_ENCODING 




2904




 





 





 





 





 





 



   




2905




 





 





 





 





 





 



 DEBUG output encoding. Default to UTF-8. 




2906




 





 





 





 





 





 



   




2907




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION 




2908




 





 





 





 





 





 



   




2909




 





 





 





 





 





 



   $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25'; 




2910




 





 





 





 





 





 



   




2911




 





 





 





 





 





 



 Suppress deprecation warnings before specified version. 




2912




 





 





 





 





 





 



   




2913




 





 





 





 





 





 



 =head1 DEPRECATED FUNCTIONALITY 




2914




 





 





 





 





 





 



   




2915




 





 





 





 





 





 



 L 




2916




 





 





 





 





 





 



   




2917




 





 





 





 





 





 



   # Methods 




2918




 





 





 





 





 





 



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




2919




 





 





 





 





 





 



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




2920




 





 





 





 





 





 



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




2921




 





 





 





 





 





 



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




2922




 





 





 





 





 





 



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




2923




 





 





 





 





 





 



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




2924




 





 





 





 





 





 



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




2925




 





 





 





 





 





 



   




2926




 





 





 





 





 





 



 L 




2927




 





 





 





 





 





 



    




2928




 





 





 





 





 





 



   # Options 




2929




 





 





 





 





 





 



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




2930




 





 





 





 





 





 



   




2931




 





 





 





 





 





 



 L 




2932




 





 





 





 





 





 



   




2933




 





 





 





 





 





 



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




2934




 





 





 





 





 





 



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




2935




 





 





 





 





 





 



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




2936




 





 





 





 





 





 



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




2937




 





 





 





 





 





 



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




2938




 





 





 





 





 





 



   




2939




 





 





 





 





 





 



 =head1 BACKWARDS COMPATIBILITY POLICY 




2940




 





 





 





 





 





 



   




2941




 





 





 





 





 





 



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




2942




 





 





 





 





 





 



 DEPRECATED feature is removed after C, 




2943




 





 





 





 





 





 



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




2944




 





 





 





 





 





 



 I extend one year each time he tell me it. 




2945




 





 





 





 





 





 



   




2946




 





 





 





 





 





 



 DEPRECATION warnings can be suppressed by C 




2947




 





 





 





 





 





 



 environment variable. 




2948




 





 





 





 





 





 



   




2949




 





 





 





 





 





 



 EXPERIMENTAL features will be changed or deleted without warnings. 




2950




 





 





 





 





 





 



   




2951




 





 





 





 





 





 



 =head1 BUGS 




2952




 





 





 





 





 





 



   




2953




 





 





 





 





 





 



 Please tell me bugs if you find bug. 




2954




 





 





 





 





 





 



   




2955




 





 





 





 





 





 



 C<<  >> 




2956




 





 





 





 





 





 



   




2957




 





 





 





 





 





 



 L 




2958




 





 





 





 





 





 



   




2959




 





 





 





 





 





 



 =head1 AUTHOR 




2960




 





 





 





 





 





 



   




2961




 





 





 





 





 





 



 Yuki Kimoto, C<<  >> 




2962




 





 





 





 





 





 



   




2963




 





 





 





 





 





 



 =head1 COPYRIGHT & LICENSE 




2964




 





 





 





 





 





 



   




2965




 





 





 





 





 





 



 Copyright 2009-2019 Yuki Kimoto, all rights reserved. 




2966




 





 





 





 





 





 



   




2967




 





 





 





 





 





 



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




2968




 





 





 





 





 





 



 under the same terms as Perl itself. 




2969




 





 





 





 





 





 



   




2970




 





 





 





 





 





 



 =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.

=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. 




2722




 





 





 





 





 





 



   




2723




 





 





 





 





 





 



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




2724




 





 





 





 





 





 



   




2725




 





 





 





 





 





 



   book.issue_date 




2726




 





 





 





 





 





 



   book.issue_datetime 




2727




 





 





 





 





 





 



   




2728




 





 





 





 





 





 



 =back 




2729




 





 





 





 





 





 



   




2730




 





 





 





 





 





 



 You get all type name used in database by C. 




2731




 





 





 





 





 





 



   




2732




 





 





 





 





 





 



   print $dbi->available_typename; 




2733




 





 





 





 





 





 



   




2734




 





 





 





 





 





 



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




2735




 





 





 





 





 





 



 C is executed after C. 




2736




 





 





 





 





 





 



 You get all data type by C. 




2737




 





 





 





 





 





 



   




2738




 





 





 





 





 





 



   print $dbi->available_datatype; 




2739




 





 





 





 





 





 



   




2740




 





 





 





 





 





 



 You can also specify multiple types at once. 




2741




 





 





 





 





 





 



   




2742




 





 





 





 





 





 



   $dbi->type_rule( 




2743




 





 





 





 





 





 



     into1 => [ 




2744




 





 





 





 





 





 



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




2745




 





 





 





 





 





 



     ], 




2746




 





 





 





 





 





 



   ); 




2747




 





 





 





 





 





 



   




2748




 





 





 





 





 





 



 =head2 update 




2749




 





 





 





 





 





 



   




2750




 





 





 





 





 





 



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




2751




 





 





 





 





 





 



   




2752




 





 





 





 





 





 



 Execute update statement. First argument is update row data. 




2753




 





 





 





 





 





 



   




2754




 





 





 





 





 





 



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




2755




 





 





 





 





 





 



 as parameter value. 




2756




 





 





 





 





 





 



   




2757




 





 





 





 





 





 



   {date => \"NOW()"} 




2758




 





 





 





 





 





 



   




2759




 





 





 





 





 





 



 B 




2760




 





 





 





 





 





 



   




2761




 





 





 





 





 





 



 C method use all of C method's options, 




2762




 





 





 





 





 





 



 and use the following new ones. 




2763




 





 





 





 





 





 



   




2764




 





 





 





 





 





 



 =over 4 




2765




 





 





 





 





 





 



   




2766




 





 





 





 





 





 



 =item prefix 




2767




 





 





 





 





 





 



   




2768




 





 





 





 





 





 



   prefix => 'or replace' 




2769




 





 





 





 





 





 



   




2770




 





 





 





 





 





 



 prefix before table name section 




2771




 





 





 





 





 





 



   




2772




 





 





 





 





 





 



   update or replace book 




2773




 





 





 





 





 





 



   




2774




 





 





 





 





 





 



 =item table 




2775




 





 





 





 





 





 



   




2776




 





 





 





 





 





 



   table => 'book' 




2777




 





 





 





 





 





 



   




2778




 





 





 





 





 





 



 Table name. 




2779




 





 





 





 





 





 



   




2780




 





 





 





 





 





 



 =item where 




2781




 





 





 





 





 





 



   




2782




 





 





 





 





 





 



 Same as C method's C option. 




2783




 





 





 





 





 





 



   




2784




 





 





 





 





 





 



 =item wrap 




2785




 





 





 





 





 





 



   




2786




 





 





 





 





 





 



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




2787




 





 





 





 





 





 



   




2788




 





 





 





 





 





 



 placeholder wrapped string. 




2789




 





 





 





 





 





 



   




2790




 





 





 





 





 





 



 If the following statement 




2791




 





 





 





 





 





 



   




2792




 





 





 





 





 





 



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




2793




 





 





 





 





 





 



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




2794




 





 





 





 





 





 



   




2795




 





 





 





 





 





 



 is executed, the following SQL is executed. 




2796




 





 





 





 





 





 



   




2797




 





 





 





 





 





 



   update book set price =  ? + 5; 




2798




 





 





 





 





 





 



   




2799




 





 





 





 





 





 



 =item mtime 




2800




 





 





 





 





 





 



   




2801




 





 





 





 





 





 



   mtime => 'modified_time' 




2802




 





 





 





 





 





 



   




2803




 





 





 





 





 





 



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




2804




 





 





 





 





 





 



 default time format is C, which can be changed by 




2805




 





 





 





 





 





 



 C attribute. 




2806




 





 





 





 





 





 



   




2807




 





 





 





 





 





 



 =back 




2808




 





 





 





 





 





 



   




2809




 





 





 





 





 





 



 =head2 update_all 




2810




 





 





 





 





 





 



   




2811




 





 





 





 





 





 



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




2812




 





 





 





 





 





 



   




2813




 





 





 





 





 





 



 Execute update statement for all rows. 




2814




 





 





 





 





 





 



 Options is same as C method. 




2815




 





 





 





 





 





 



   




2816




 





 





 





 





 





 



 =over 4 




2817




 





 





 





 





 





 



   




2818




 





 





 





 





 





 



 =item option 




2819




 





 





 





 





 





 



   




2820




 





 





 





 





 





 



   option => { 




2821




 





 





 





 





 





 



     select => { 




2822




 





 





 





 





 





 



       append => '...' 




2823




 





 





 





 





 





 



     }, 




2824




 





 





 





 





 





 



     insert => { 




2825




 





 





 





 





 





 



       prefix => '...' 




2826




 





 





 





 





 





 



     }, 




2827




 





 





 





 





 





 



     update => { 




2828




 





 





 





 





 





 



       filter => {} 




2829




 





 





 





 





 





 



     } 




2830




 





 





 





 





 





 



   } 




2831




 





 





 





 





 





 



   




2832




 





 





 





 





 





 



 If you want to pass option to each method, 




2833




 





 





 





 





 





 



 you can use C option. 




2834




 





 





 





 





 





 



   




2835




 





 





 





 





 





 



 =over 4 




2836




 





 





 





 





 





 



   




2837




 





 





 





 





 





 



 =item select_option 




2838




 





 





 





 





 





 



   




2839




 





 





 





 





 





 



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




2840




 





 





 





 





 





 



   




2841




 





 





 





 





 





 



 select method option, 




2842




 





 





 





 





 





 



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




2843




 





 





 





 





 





 



   




2844




 





 





 





 





 





 



 =head2 show_datatype 




2845




 





 





 





 





 





 



   




2846




 





 





 





 





 





 



   $dbi->show_datatype($table); 




2847




 





 





 





 





 





 



   




2848




 





 





 





 





 





 



 Show data type of the columns of specified table. 




2849




 





 





 





 





 





 



   




2850




 





 





 





 





 





 



   book 




2851




 





 





 





 





 





 



   title: 5 




2852




 





 





 





 





 





 



   issue_date: 91 




2853




 





 





 





 





 





 



   




2854




 





 





 





 





 





 



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




2855




 





 





 





 





 





 



   




2856




 





 





 





 





 





 



 =head2 show_tables 




2857




 





 





 





 





 





 



   




2858




 





 





 





 





 





 



   $dbi->show_tables; 




2859




 





 





 





 





 





 



   




2860




 





 





 





 





 





 



 Show tables. 




2861




 





 





 





 





 





 



   




2862




 





 





 





 





 





 



 =head2 show_typename 




2863




 





 





 





 





 





 



   




2864




 





 





 





 





 





 



   $dbi->show_typename($table); 




2865




 





 





 





 





 





 



   




2866




 





 





 





 





 





 



 Show type name of the columns of specified table. 




2867




 





 





 





 





 





 



   




2868




 





 





 





 





 





 



   book 




2869




 





 





 





 





 





 



   title: varchar 




2870




 





 





 





 





 





 



   issue_date: date 




2871




 





 





 





 





 





 



   




2872




 





 





 





 





 





 



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




2873




 





 





 





 





 





 



   




2874




 





 





 





 





 





 



 =head2 values_clause 




2875




 





 





 





 





 





 



   




2876




 





 





 





 





 





 



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




2877




 





 





 





 





 





 



   




2878




 





 





 





 





 





 



 Create values clause. 




2879




 





 





 





 





 





 



   




2880




 





 





 





 





 





 



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




2881




 





 





 





 





 





 



   




2882




 





 





 





 





 





 



 You can use this in insert statement. 




2883




 





 





 





 





 





 



   




2884




 





 





 





 





 





 



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




2885




 





 





 





 





 





 



   




2886




 





 





 





 





 





 



 =head2 where 




2887




 





 





 





 





 





 



   




2888




 





 





 





 





 





 



   my $where = $dbi->where; 




2889




 





 





 





 





 





 



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




2890




 





 





 





 





 





 



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




2891




 





 





 





 





 





 



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




2892




 





 





 





 





 





 



   




2893




 





 





 





 





 





 



 Create a new L object. 




2894




 





 





 





 





 





 



 See L to know how to create where clause. 




2895




 





 





 





 





 





 



   




2896




 





 





 





 





 





 



 =head1 ENVIRONMENTAL VARIABLES 




2897




 





 





 





 





 





 



   




2898




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG 




2899




 





 





 





 





 





 



   




2900




 





 





 





 





 





 



 If environment variable C is set to true, 




2901




 





 





 





 





 





 



 executed SQL and bind values are printed to STDERR. 




2902




 





 





 





 





 





 



   




2903




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_DEBUG_ENCODING 




2904




 





 





 





 





 





 



   




2905




 





 





 





 





 





 



 DEBUG output encoding. Default to UTF-8. 




2906




 





 





 





 





 





 



   




2907




 





 





 





 





 





 



 =head2 DBIX_CUSTOM_SUPPRESS_DEPRECATION 




2908




 





 





 





 





 





 



   




2909




 





 





 





 





 





 



   $ENV{DBIX_CUSTOM_SUPPRESS_DEPRECATION} = '0.25'; 




2910




 





 





 





 





 





 



   




2911




 





 





 





 





 





 



 Suppress deprecation warnings before specified version. 




2912




 





 





 





 





 





 



   




2913




 





 





 





 





 





 



 =head1 DEPRECATED FUNCTIONALITY 




2914




 





 





 





 





 





 



   




2915




 





 





 





 





 





 



 L 




2916




 





 





 





 





 





 



   




2917




 





 





 





 





 





 



   # Methods 




2918




 





 





 





 





 





 



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




2919




 





 





 





 





 





 



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




2920




 





 





 





 





 





 



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




2921




 





 





 





 





 





 



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




2922




 





 





 





 





 





 



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




2923




 





 





 





 





 





 



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




2924




 





 





 





 





 





 



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




2925




 





 





 





 





 





 



   




2926




 





 





 





 





 





 



 L 




2927




 





 





 





 





 





 



    




2928




 





 





 





 





 





 



   # Options 




2929




 





 





 





 





 





 



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




2930




 





 





 





 





 





 



   




2931




 





 





 





 





 





 



 L 




2932




 





 





 





 





 





 



   




2933




 





 





 





 





 





 



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




2934




 





 





 





 





 





 



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




2935




 





 





 





 





 





 



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




2936




 





 





 





 





 





 



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




2937




 





 





 





 





 





 



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




2938




 





 





 





 





 





 



   




2939




 





 





 





 





 





 



 =head1 BACKWARDS COMPATIBILITY POLICY 




2940




 





 





 





 





 





 



   




2941




 





 





 





 





 





 



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




2942




 





 





 





 





 





 



 DEPRECATED feature is removed after C, 




2943




 





 





 





 





 





 



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




2944




 





 





 





 





 





 



 I extend one year each time he tell me it. 




2945




 





 





 





 





 





 



   




2946




 





 





 





 





 





 



 DEPRECATION warnings can be suppressed by C 




2947




 





 





 





 





 





 



 environment variable. 




2948




 





 





 





 





 





 



   




2949




 





 





 





 





 





 



 EXPERIMENTAL features will be changed or deleted without warnings. 




2950




 





 





 





 





 





 



   




2951




 





 





 





 





 





 



 =head1 BUGS 




2952




 





 





 





 





 





 



   




2953




 





 





 





 





 





 



 Please tell me bugs if you find bug. 




2954




 





 





 





 





 





 



   




2955




 





 





 





 





 





 



 C<<  >> 




2956




 





 





 





 





 





 



   




2957




 





 





 





 





 





 



 L 




2958




 





 





 





 





 





 



   




2959




 





 





 





 





 





 



 =head1 AUTHOR 




2960




 





 





 





 





 





 



   




2961




 





 





 





 





 





 



 Yuki Kimoto, C<<  >> 




2962




 





 





 





 





 





 



   




2963




 





 





 





 





 





 



 =head1 COPYRIGHT & LICENSE 




2964




 





 





 





 





 





 



   




2965




 





 





 





 





 





 



 Copyright 2009-2019 Yuki Kimoto, all rights reserved. 




2966




 





 





 





 





 





 



   




2967




 





 





 





 





 





 



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




2968




 





 





 





 





 





 



 under the same terms as Perl itself. 




2969




 





 





 





 





 





 



   




2970




 





 





 





 





 





 



 =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