sql-maker 0.0.2 → 0.0.3

data/lib/sql/maker.rb

@@ -339,338 +339,3 @@ class SQL::Maker
     return stmt
   end
 end
-
-__END__
-
-=encoding utf8
-
-=head1 NAME
-
-SQL::Maker - Yet another SQL builder
-
-=head1 SYNOPSIS
-
-    use SQL::Maker
-
-    builder = SQL::Maker.new(
-        :driver => 'SQLite', # or your favorite driver
-    )
-
-    # SELECT
-    sql, bind = builder.select(table, fields, where, opt)
-
-    # INSERT
-    sql, bind = builder.insert(table, values, opt)
-
-    # DELETE
-    sql, bind = builder.delete(table, where, opt)
-
-    # UPDATE
-    sql, bind = builder.update(table, set, where)
-    sql, bind = builder.update(table, set, where)
-
-=head1 DESCRIPTION
-
-SQL::Maker is yet another SQL builder class.
-
-=head1 METHODS
-
-=over 4
-
-=item C<< builder = SQL::Maker.new(args) >>
-
-Create new instance of SQL::Maker.
-
-Attributes are the following:
-
-=over 4
-
-=item driver: Str
-
-Driver name is required. The driver type is needed to create SQL string.
-
-=item quote_char: Str
-
-This is the character that a table or column name will be quoted with.
-
-Default: auto detect from driver.
-
-=item name_sep: Str
-
-This is the character that separates a table and column name.
-
-Default: '.'
-
-=item new_line: Str
-
-This is the character that separates a part of statements.
-
-Default: '\n'
-
-=item strict: Bool
-
-In strict mode, all the expressions must be declared by using instances of SQL::QueryMaker
-
-Default: false
-
-=back
-
-=item C<< select = builder.new_select(args) >>
-
-Create new instance of L<SQL::Maker::Select> using the settings from B<builder>.
-
-This method returns an instance of L<SQL::Maker::Select>.
-
-=item C<< sql, bind = builder.select(table|tables, fields, where, opt) >>
-
-    sql, bind = builder.select('user', ['*'], {:name => 'john'}, {:order_by => 'user_id DESC'})
-    # =>
-    #   SELECT * FROM `user` WHERE (`name` = ?) ORDER BY user_id DESC
-    #   ['john']
-
-This method returns the SQL string and bind variables for a SELECT statement.
-
-=over 4
-
-=item C<< table >>
-
-=item C<< \@tables >>
-
-Table name for the B<FROM> clause as scalar or arrayref. You can specify the instance of B<SQL::Maker::Select> for a sub-query.
-
-If you are using C<< opt.joins >> this should be I<< undef >> since it's passed via the first join.
-
-=item C<< \@fields >>
-
-This is a list for retrieving fields from database.
-
-Each element of the C<@fields> is normally a scalar or a scalar ref containing the column name.
-If you want to specify an alias of the field, you can use an arrayref containing a pair
-of column and alias names (e.g. C<< ['foo.id' => 'foo_id'] >>).
-
-=item C<< \%where >>
-
-=item C<< \@where >>
-
-=item C<< where >>
-
-where clause from hashref or arrayref via L<SQL::Maker::Condition>, or L<SQL::Maker::Condition> object.
-
-=item C<< \%opt >>
-
-These are the options for the SELECT statement
-
-=over 4
-
-=item C<< opt.prefix >>
-
-This is a prefix for the SELECT statement.
-
-For example, you can provide the 'SELECT SQL_CALC_FOUND_ROWS '. It's useful for MySQL.
-
-Default Value: 'SELECT '
-
-=item C<< opt.limit >>
-
-This option adds a 'LIMIT n' clause.
-
-=item C<< opt.offset >>
-
-This option adds an 'OFFSET n' clause.
-
-=item C<< opt.order_by >>
-
-This option adds an B<ORDER BY> clause
-
-You can write it in any of the following forms:
-
-    builder.select(..., {:order_by => 'foo DESC, bar ASC'})
-    builder.select(..., {:order_by => ['foo DESC', 'bar ASC']})
-    builder.select(..., {:order_by => {:foo => 'DESC'}})
-    builder.select(..., {:order_by => [{:foo => 'DESC'}, {:bar => 'ASC'}]})
-
-=item C<< opt.group_by >>
-
-This option adds a B<GROUP BY> clause
-
-You can write it in any of the following forms:
-
-    builder.select(..., {:group_by => 'foo DESC, bar ASC'})
-    builder.select(..., {:group_by => ['foo DESC', 'bar ASC']})
-    builder.select(..., {:group_by => {:foo => 'DESC'}})
-    builder.select(..., {:group_by => [{:foo => 'DESC'}, {:bar => 'ASC'}]})
-
-=item C<< opt.having >>
-
-This option adds a HAVING clause
-
-=item C<< opt.for_update >>
-
-This option adds a 'FOR UPDATE" clause.
-
-=item C<< opt.joins >>
-
-This option adds a 'JOIN' via L<SQL::Maker::Select>.
-
-You can write it as follows:
-
-    builder.select(undef, ..., {:joins => [[:user => {:table => 'group', :condition => 'user.gid = group.gid'}], ...]})
-
-=item C<< opt.index_hint >>
-
-This option adds an INDEX HINT like as 'USE INDEX' clause for MySQL via L<SQL::Maker::Select>.
-
-You can write it as follows:
-
-    builder.select(..., { :index_hint => 'foo' })
-    builder.select(..., { :index_hint => ['foo', 'bar'] })
-    builder.select(..., { :index_hint => { :list => 'foo' })
-    builder.select(..., { :index_hint => { :type => 'FORCE', :list => ['foo', 'bar'] })
-
-=back
-
-=back
-
-=item C<< sql, bind = builder.insert(table, \%values|\@values, \%opt); >>
-
-    sql, bind = builder.insert(:user => {:name => 'john'})
-    # =>
-    #    INSERT INTO `user` (`name`) VALUES (?)
-    #    ['john']
-
-Generate an INSERT query.
-
-=over 4
-
-=item C<< table >>
-
-Table name in scalar.
-
-=item C<< \%values >>
-
-These are the values for the INSERT statement.
-
-=item C<< \%opt >>
-
-These are the options for the INSERT statement
-
-=over 4
-
-=item C<< opt.prefix >>
-
-This is a prefix for the INSERT statement.
-
-For example, you can provide 'INSERT IGNORE INTO' for MySQL.
-
-Default Value: 'INSERT INTO'
-
-=back
-
-=back
-
-=item C<< sql, bind = builder.delete(table, \%where|\@where|where, \%opt); >>
-
-    sql, bind = builder.delete(table, \%where)
-    # =>
-    #    DELETE FROM `user` WHERE (`name` = ?)
-    #    ['john']
-
-Generate a DELETE query.
-
-=over 4
-
-=item C<< table >>
-
-Table name in scalar.
-
-=item C<< \%where >>
-
-=item C<< \@where >>
-
-=item C<< where >>
-
-where clause from hashref or arrayref via L<SQL::Maker::Condition>, or L<SQL::Maker::Condition> object.
-
-=item C<< \%opt >>
-
-These are the options for the DELETE statement
-
-=over 4
-
-=item C<< opt.using >>
-
-This option adds a USING clause. It takes a scalar or an arrayref of table names as argument:
-
-    (sql, bind) = bulder.delete(table, \%where, { :using => 'group' })
-    # =>
-    #    DELETE FROM `user` USING `group` WHERE (`group`.`name` = ?)
-    #    ['doe']
-    bulder.delete(..., { :using => ['bar', 'qux'] })
-
-=back
-
-=back
-
-=item C<< sql, bind = builder.update(table, \%set|@set, \%where|\@where|where); >>
-
-Generate a UPDATE query.
-
-    sql, bind = builder.update('user', ['name' => 'john', :email => 'john@example.com'], {:user_id => 3})
-    # =>
-    #    'UPDATE `user` SET `name` = ?, `email` = ? WHERE (`user_id` = ?)'
-    #    ['john','john@example.com',3]
-
-=over 4
-
-=item table
-
-Table name in scalar.
-
-=item \%set
-
-Setting values.
-
-=item \%where
-
-=item \@where
-
-=item where
-
-where clause from a hashref or arrayref via L<SQL::Maker::Condition>, or L<SQL::Maker::Condition> object.
-
-=back
-
-=item C<< builder.new_condition() >>
-
-Create new L<SQL::Maker::Condition> object from C< builder > settings.
-
-=item C<< sql, bind = builder.where(where) >>
-
-Where clause from a hashref or arrayref via L<SQL::Maker::Condition>, or L<SQL::Maker::Condition> object.
-
-=back
-
-=head1 PLUGINS
-
-SQL::Maker features a plugin system. Write the code as follows:
-
-    require 'sql/maker'
-    SQL::Maker.load_plugin('insert_multi')
-
-=head1 FAQ
-
-=over 4
-
-=item Why don't you use Arel or ActiveRecord?
-
-I wanted a query builder rather than ORM.
-
-I wanted simpler one than Arel.
-
-=back
-
-=head1 SEE ALSO
-
-https://github.com/tokuhirom/SQL-Maker
-
-=cut

data/lib/sql/maker/condition.rb

@@ -186,204 +186,3 @@ class SQL::Maker::Condition
     @auto_bind ? bind_param(sql, self.bind) : sql
   end
 end
-
-__END__
-
-=for test_synopsis
-my (sql, @bind)
-
-=head1 NAME
-
-SQL::Maker::Condition - condition object for SQL::Maker
-
-=head1 SYNOPSIS
-
-    my condition = SQL::Maker::Condition.new(
-        name_sep   => '.',
-        quote_char => '`',
-    )
-    condition.add('foo_id' => 3)
-    condition.add('bar_id' => 4)
-    sql = condition.as_sql() # (`foo_id`=?) AND (`bar_id`=?)
-    @bind = condition.bind()  # (3, 4)
-
-    # add_raw
-    my condition = SQL::Maker::Condition.new(
-        name_sep   => '.',
-        quote_char => '`',
-    )
-    condition.add_raw('EXISTS(SELECT * FROM bar WHERE name = ?)' => ['john'])
-    condition.add_raw('type IS NOT NULL')
-    sql = condition.as_sql() # (EXISTS(SELECT * FROM bar WHERE name = ?)) AND (type IS NOT NULL)
-    @bind = condition.bind()  # ('john')
-
-    # composite and
-    my other = SQL::Maker::Condition.new(
-        name_sep => '.',
-        quote_char => '`',
-    )
-    other.add('name' => 'john')
-    my $comp_and = condition & other
-    sql = $comp_and.as_sql() # ((`foo_id`=?) AND (`bar_id`=?)) AND (`name`=?)
-    @bind = $comp_and.bind()  # (3, 4, 'john')
-
-    # composite or
-    my $comp_or = condition | other
-    sql = $comp_and.as_sql() # ((`foo_id`=?) AND (`bar_id`=?)) OR (`name`=?)
-    @bind = $comp_and.bind()  # (3, 4, 'john')
-
-
-=head1 CONDITION CHEAT SHEET
-
-Here is a cheat sheet for conditions.
-
-    IN:        {'foo'=>'bar'}
-    OUT QUERY: '`foo` = ?'
-    OUT BIND:  ['bar']
-
-    IN:        {'foo'=>['bar','baz']}
-    OUT QUERY: '`foo` IN (?, ?)'
-    OUT BIND:  ['bar','baz']
-
-    IN:        {'foo'=>{'IN' => ['bar','baz']}}
-    OUT QUERY: '`foo` IN (?, ?)'
-    OUT BIND:  ['bar','baz']
-
-    IN:        {'foo'=>{'not IN' => ['bar','baz']}}
-    OUT QUERY: '`foo` NOT IN (?, ?)'
-    OUT BIND:  ['bar','baz']
-
-    IN:        {'foo'=>{'!=' => 'bar'}}
-    OUT QUERY: '`foo` != ?'
-    OUT BIND:  ['bar']
-
-#    IN:        {'foo'=>\'IS NOT NULL'}
-#    OUT QUERY: '`foo` IS NOT NULL'
-#    OUT BIND:  []
-
-    IN:        {'foo'=>{'between' => ['1','2']}}
-    OUT QUERY: '`foo` BETWEEN ? AND ?'
-    OUT BIND:  ['1','2']
-
-    IN:        {'foo'=>{'like' => 'xaic%'}}
-    OUT QUERY: '`foo` LIKE ?'
-    OUT BIND:  ['xaic%']
-
-    IN:        {'foo'=>[{'>' => 'bar'},{'<' => 'baz'}]}
-    OUT QUERY: '(`foo` > ?) OR (`foo` < ?)'
-    OUT BIND:  ['bar','baz']
-
-    IN:        {'foo'=>{:AND => [{'>' => 'bar'},{'<' => 'baz'}]}}
-    OUT QUERY: '(`foo` > ?) AND (`foo` < ?)'
-    OUT BIND:  ['bar','baz']
-
-    IN:        {'foo'=>{:AND => ['foo','bar','baz']}}
-    OUT QUERY: '(`foo` = ?) AND (`foo` = ?) AND (`foo` = ?)'
-    OUT BIND:  ['foo','bar','baz']
-
-    IN:        {'foo_id'=>{'IN' => sql_raw('SELECT foo_id FROM bar WHERE t=?',44)}}
-    OUT QUERY: '`foo_id` IN (SELECT foo_id FROM bar WHERE t=?)'
-    OUT BIND:  [44]
-
-#    IN:        ['foo_id',\['MATCH (col1, col2) AGAINST (?)','apples']]
-#    OUT QUERY: '`foo_id` MATCH (col1, col2) AGAINST (?)'
-#    OUT BIND:  ['apples']
-
-    IN:        {'foo_id'=>nil}
-    OUT QUERY: '`foo_id` IS NULL'
-    OUT BIND:  []
-
-    IN:        {'foo_id'=>{'IN' => []}}
-    OUT QUERY: '0=1'
-    OUT BIND:  []
-
-    IN:        {'foo_id'=>{'NOT IN' => []}}
-    OUT QUERY: '1=1'
-    OUT BIND:  []
-
-#    IN:        ['foo_id', [123,sql_type(\3, SQL_INTEGER)]]
-#    OUT QUERY: '`foo_id` IN (?, ?)'
-#    OUT BIND:  (123, sql_type(\3, SQL_INTEGER))
-#
-#    IN:        ['foo_id', sql_type(\3, SQL_INTEGER)]
-#    OUT QUERY: '`foo_id` = ?'
-#    OUT BIND:  sql_type(\3, SQL_INTEGER)
-#
-#    IN:        ['created_on', { '>', \'DATE_SUB(NOW(), INTERVAL 1 DAY)' }]
-#    OUT QUERY: '`created_on` > DATE_SUB(NOW(), INTERVAL 1 DAY)'
-#    OUT BIND:  
-
-It is also possible to use the functions exported by C<SQL::QueryMaker> to define the conditions.
-
-    IN:        {'foo' => sql_in(['bar','baz'])}
-    OUT QUERY: '`foo` IN (?,?)'
-    OUT BIND:  ['bar','baz']
-
-    IN:        {'foo' => sql_lt(3)}
-    OUT QUERY: '`foo` < ?'
-    OUT BIND:  [3]
-
-    IN:        {'foo' => sql_not_in(['bar','baz'])}
-    OUT QUERY: '`foo` NOT IN (?,?)'
-    OUT BIND:  ['bar','baz']
-
-    IN:        {'foo' => sql_ne('bar')}
-    OUT QUERY: '`foo` != ?'
-    OUT BIND:  ['bar']
-
-    IN:        {'foo' => sql_is_not_null()}
-    OUT QUERY: '`foo` IS NOT NULL'
-    OUT BIND:  []
-
-    IN:        {'foo' => sql_between('1','2')}
-    OUT QUERY: '`foo` BETWEEN ? AND ?'
-    OUT BIND:  ['1','2']
-
-    IN:        {'foo' => sql_like('xaic%')}
-    OUT QUERY: '`foo` LIKE ?'
-    OUT BIND:  ['xaic%']
-
-    IN:        {'foo' => sql_or([sql_gt('bar'), sql_lt('baz')])}
-    OUT QUERY: '(`foo` > ?) OR (`foo` < ?)'
-    OUT BIND:  ['bar','baz']
-
-    IN:        {'foo' => sql_and([sql_gt('bar'), sql_lt('baz')])}
-    OUT QUERY: '(`foo` > ?) AND (`foo` < ?)'
-    OUT BIND:  ['bar','baz']
-
-    IN:        {'foo_id' => sql_op('IN (SELECT foo_id FROM bar WHERE t=?)',[44])}
-    OUT QUERY: '`foo_id` IN (SELECT foo_id FROM bar WHERE t=?)'
-    OUT BIND:  [44]
-
-    IN:        {'foo_id' => sql_in([sql_raw('SELECT foo_id FROM bar WHERE t=?',44)])}
-    OUT QUERY: '`foo_id` IN ((SELECT foo_id FROM bar WHERE t=?))'
-    OUT BIND:  [44]
-
-    IN:        {'foo_id' => sql_op('MATCH (@) AGAINST (?)',['apples'])}
-    OUT QUERY: 'MATCH (`foo_id`) AGAINST (?)'
-    OUT BIND:  ['apples']
-
-    IN:        {'foo_id'=>sql_in([])}
-    OUT QUERY: '0=1'
-    OUT BIND:  []
-
-    IN:        {'foo_id'=>sql_not_in([])}
-    OUT QUERY: '1=1'
-    OUT BIND:  []
-
-#    IN:        ['foo_id', sql_type(\3, SQL_INTEGER)]
-#    OUT QUERY: '`foo_id` = ?'
-#    OUT BIND:  sql_type(\3, SQL_INTEGER)
-#
-#    IN:        ['foo_id', sql_in([sql_type(\3, SQL_INTEGER)])]
-#    OUT QUERY: '`foo_id` IN (?)'
-#    OUT BIND:  sql_type(\3, SQL_INTEGER)
-#
-#    IN:        ['created_on', sql_gt(sql_raw('DATE_SUB(NOW(), INTERVAL 1 DAY)')) ]
-#    OUT QUERY: '`created_on` > DATE_SUB(NOW(), INTERVAL 1 DAY)'
-#    OUT BIND:
-
-=head1 SEE ALSO
-
-L<SQL::Maker>
-