sequel 4.49.0 → 5.0.0

data/doc/object_model.rdoc

@@ -6,13 +6,12 @@ Sequel objects by calling #new on the object's class (other than Sequel::Model
 instances).  However, just as almost everything in ruby is an object, all 
 the methods you call in Sequel deal with objects behind the scenes.
 
-There are five main types of Sequel-specific objects that you deal with in
-Sequel:
+In addition to the standard ruby types, there are four main types of
+Sequel-specific objects that you deal when programming with Sequel:
 
 * Sequel::Database
 * Sequel::Dataset
 * Sequel::Model
-* Standard Ruby Types
 * Sequel::SQL::Expression (and subclasses)
 
 == Sequel::Database
@@ -47,27 +46,27 @@ and literalize the object to an SQL string fragment:
 
 == Sequel::Dataset
 
-Sequel::Dataset objects represent SQL queries, or more generally, they represent
-abstract collections of rows in the database.  They are usually created from
+Sequel::Dataset objects represent SQL queries.  They are created from
 a Sequel::Database object:
 
   dataset = DB[:table]         # SELECT * FROM "table"
   dataset = DB.from(table)     # SELECT * FROM "table"
   dataset = DB.select(:column) # SELECT "column"
 
-Most Sequel::Dataset methods return modified copies of the receiver, and the
-general way to build queries in Sequel is via a method chain:
+Most Sequel::Dataset methods that do not execute queries return modified
+copies of the receiver, and the general way to build queries in Sequel is
+via a method chain:
 
   dataset = DB[:test].
               select(:column1, :column2).
-              where(:column3 => 4).
+              where(column3: 4).
               order(:column5)
 
 Such a method chain is a more direct way of doing:
 
   dataset = DB[:test]
   dataset = dataset.select(:column1, :column2)
-  dataset = dataset.where(:column3 => 4)
+  dataset = dataset.where(column3: 4)
   dataset = dataset.order(:column5)
 
 When you are ready to execute your query, you call one of the Sequel::Dataset
@@ -79,8 +78,8 @@ action methods.  For returning rows, you can do:
 
 For inserting, updating, or deleting rows, you can do:
 
-  dataset.insert(:column=>value)
-  dataset.update(:column=>value)
+  dataset.insert(column: value)
+  dataset.update(column: value)
   dataset.delete
 
 All datasets are related to their database object, which you can access via
@@ -90,7 +89,7 @@ the Sequel::Dataset#db method:
 
 == Sequel::Model
 
-Sequel::Model objects are wrappers around a particular Sequel::Dataset object that
+Sequel::Model classes are wrappers around a particular Sequel::Dataset object that
 add custom behavior, both custom behavior for the entire set of rows in the dataset
 (the model's class methods), custom behavior for a subset of rows in the dataset
 (the model's dataset methods), and custom behavior for single rows in the dataset
@@ -103,6 +102,13 @@ generally created by the user using standard ruby syntax:
   end
   album = Album.new
 
+Model classes that use a non-default Database instance or table name generally
+use the Sequel::Model method to create the superclass:
+
+  class Album < Sequel::Model(DB[:music_albums])
+  end
+  album = Album.new
+
 All model classes are related to their Sequel::Dataset object, which you
 can access via the Sequel::Model.dataset method:
 
@@ -121,34 +127,12 @@ if you pass the left side to Sequel::Database#literal.
 
 === Symbol
 
-For example, ruby symbols represent SQL identifiers (tables, columns, schemas):
+Ruby symbols represent SQL identifiers (tables, columns, schemas):
 
+  :schema # "schema"
   :table  # "table"
   :column # "column"
 
-By default, Sequel supports splitting symbols using double or triple underscores
-to represent qualified and aliased identifiers.  A symbol with a double underscore
-is treated as a qualified identifier:
-
-  :table__column # "table"."column"
-
-A symbol with a triple underscore is treated as an aliased identifier:
-
-  :column___alias # "column" AS "alias"
-
-A symbol with a double underscore followed by a triple underscore is treated
-as an aliased qualified identifer:
-
-  :table__column___alias # "table"."column" AS "alias"
-
-By allowing the creation of qualified and aliased identifiers via symbols,
-Sequel makes it simpler to represent more SQL expressions.  However, if you
-are using double or triple underscores in your own identifiers, Sequel's
-automatic splitting of identifiers can be problematic, in which case you
-may want to turn them off via:
-
-  Sequel.split_symbols = false
-
 === Integer, Float, BigDecimal, String, Date, Time, DateTime
 
 Ruby's Integer, Float, BigDecimal, String, Date, Time, and DateTime classes
@@ -166,31 +150,31 @@ represent similar types in SQL:
 
 Sequel generally uses hash objects to represent equality:
 
-  {:column => 1} # ("column" = 1)
+  {column: 1} # ("column" = 1)
 
-However, if you use an array as the hash value, it will usually be used to represent inclusion:
+However, if you use an array as the hash value, it represents inclusion in the value list:
 
-  {:column => [1, 2, 3]} # ("column" IN (1, 2, 3))
+  {column: [1, 2, 3]} # ("column" IN (1, 2, 3))
 
 You can also use a Sequel::Dataset instance as the hash value, which will be used to
 represent inclusion in the subselect:
 
-  {:column => DB[:table].select(:column)} # ("column" IN (SELECT "column" FROM "table"))
+  {column: DB[:table].select(:column)} # ("column" IN (SELECT "column" FROM "table"))
 
-If you pass true, false, or nil as the hash value, it will be used to represent identity:
+If you pass true, false, or nil as the hash value, it represents identity:
 
-  {:column => nil} # ("column" IS NULL)
+  {column: nil} # ("column" IS NULL)
 
 If you pass a Range object, it will be used as the bounds for a greater than and less than
 operation:
 
-  {:column => 1..2} # (("column" >= 1) AND ("column" <= 2))
-  {:column => 1...3} # (("column" >= 1) AND ("column" < 3))
+  {column: 1..2}  # (("column" >= 1) AND ("column" <= 2))
+  {column: 1...3} # (("column" >= 1) AND ("column" < 3))
 
 If you pass a Regexp object as the value, it will be used as a regular expression
-operation (only supported on PostgreSQL and MySQL currently):
+operation if the database supports it:
 
-  {:column => /a.*b/} # ("column" ~ 'a.*b')
+  {column: /a.*b/} # ("column" ~ 'a.*b')
 
 === Array
 
@@ -259,9 +243,8 @@ no additional behavior, so it can be instantiated like a normal array:
 
   Sequel::SQL::ValueList.new([[1, 2], [3, 4]]) # ((1, 2), (3, 4))
 
-In old versions of Sequel, these objects often needed to be created manually,
-but in newer versions of Sequel, they are created automatically in most cases
-where they are required.
+In general, you don't need to create Sequel::SQL::ValueList instances manually,
+they will be created automatically where they are required in most cases.
 
 The following shortcuts exist for creating Sequel::SQL::ValueList objects:
 
@@ -271,16 +254,16 @@ The following shortcuts exist for creating Sequel::SQL::ValueList objects:
 === Sequel::SQL::Identifier
 
 Sequel::SQL::Identifier objects represent single identifiers.  The main reason for
-their existence is that they are not checked for double or triple underscores, so no
-automatic qualification or aliasing happens for them:
+their existence is they support many additional Sequel specific methods that are
+not supported on plain symbols:
 
-  Sequel::SQL::Identifier.new(:col__umn) # "col__umn"
+  Sequel::SQL::Identifier.new(:colum) # "col"
 
 The following shortcuts exist for creating Sequel::SQL::Identifier objects:
 
   Sequel[:column]
-  Sequel.identifier(:col__umn)
-  :col__umn.identifier # core_extensions extension
+  Sequel.identifier(:column)
+  :column.identifier # core_extensions extension
 
 === Sequel::SQL::QualifiedIdentifier
 
@@ -290,7 +273,6 @@ Sequel::SQL::QualifiedIdentifier objects represent qualified identifiers:
 
 The following shortcuts exist for creating Sequel::SQL::QualifiedIdentifier objects:
 
-  Sequel[:table__column]
   Sequel[:table][:column]
   Sequel.qualify(:table, :column)
   :column.qualify(:table) # core_extensions extension
@@ -303,12 +285,14 @@ is treated as an identifier, but the expression can be an arbitrary Sequel expre
   Sequel::SQL::AliasedExpression.new(:column, :alias)
   # "column" AS "alias"
 
+Derived column lists are also supported:
+
   Sequel::SQL::AliasedExpression.new(:table, :alias, [:column_alias1, :column_alias2])
   # "table" AS "alias"("column_alias1", "column_alias2")
 
 The following shortcuts exist for creating Sequel::SQL::AliasedExpression objects:
 
-  Sequel[:column___alias]
+  Sequel[:column].as(:alias)
   Sequel.as(:column, :alias)
   Sequel.as(:column, :alias, [:column_alias1, :column_alias2])
   :column.as(:alias) # core_extensions or symbol_as extension
@@ -347,7 +331,7 @@ against:
 
 Or they can treat each condition separately:
  
-  Sequel::SQL::CaseExpression.new({{:a=>2}=>1}, 0) # CASE WHEN ("a" = 2) THEN 1 ELSE 0 END
+  Sequel::SQL::CaseExpression.new({{a: 2}=>1}, 0) # CASE WHEN ("a" = 2) THEN 1 ELSE 0 END
 
 In addition to providing a hash, you can also provide an array of two-element arrays:
 
@@ -356,10 +340,10 @@ In addition to providing a hash, you can also provide an array of two-element ar
 The following shortcuts exist for creating Sequel::SQL::CaseExpression objects:
 
   Sequel.case({2=>1}, 0, :a)
-  Sequel.case({{:a=>2}=>1}, 0)
+  Sequel.case({{a: 2}=>1}, 0)
 
   {2=>1}.case(0, :a) # core_extensions extension
-  {{:a=>2}=>1}.case(0) # core_extensions extension
+  {{a: 2}=>1}.case(0) # core_extensions extension
 
 === Sequel::SQL::Cast
 
@@ -384,16 +368,14 @@ The following shortcuts exist for creating Sequel::SQL::Cast objects:
 
 === Sequel::SQL::ColumnAll
 
-Sequel::SQL::ColumnAll objects represent the selection of all columns from a
-table.  They are pretty much only used as arguments to one of the Dataset select
-methods, and are not used much anymore since Dataset#select_all was expanded to
-take arguments.  Still, it's possible they are still useful in some code:
+Sequel::SQL::ColumnAll objects represent the selection of all columns from a table:
 
   Sequel::SQL::ColumnAll.new(:table) # "table".*
 
 The following shortcut exists for creating Sequel::SQL::ColumnAll objects:
 
   Sequel[:table].*
+  Sequel[:schema][:table].*
   :table.* # core_extensions extension
 
 === Sequel::SQL::Constant
@@ -407,7 +389,7 @@ Sequel namespace:
 
 These objects are usually used as values in queries:
 
-  DB[:table].insert(:time=>Sequel::CURRENT_TIMESTAMP)
+  DB[:table].insert(time: Sequel::CURRENT_TIMESTAMP)
 
 === Sequel::SQL::DelayedEvaluation
 
@@ -466,7 +448,7 @@ The first type uses question marks with multiple placeholder value objects:
 The second uses named placeholders with colons and a hash of placeholder
 value objects:
 
-  Sequel::SQL::PlaceholderLiteralString.new(':b = :v', [{:b=>:a, :v=>1}]) # "a" = 1
+  Sequel::SQL::PlaceholderLiteralString.new(':b = :v', [{b: :a, v: 1}]) # "a" = 1
 
 The third uses an array instead of a string, with multiple placeholder
 objects, each one going in between the members of the array:
@@ -482,7 +464,7 @@ The following shortcuts exist for creating Sequel::SQL::PlaceholderLiteralString
 objects:
 
   Sequel.lit('? = ?', :a, 1)
-  Sequel.lit(':b = :v', :b=>:a, :v=>1)
+  Sequel.lit(':b = :v', b: :a, v: 1)
   Sequel.lit(['', ' = '], :a, 1)
 
   '? = ?'.lit(:a, 1) # core_extensions extension
@@ -552,10 +534,10 @@ Sequel::SQL::Window objects represent the windows used by Sequel::SQL::Function.
 They use a hash-based API, supporting the :frame, :order, :partition, and :window
 options:
 
-  Sequel::SQL::Window.new(:order=>:a) # (ORDER BY "a")
-  Sequel::SQL::Window.new(:partition=>:a) # (PARTITION BY "a")
+  Sequel::SQL::Window.new(order: :a) # (ORDER BY "a")
+  Sequel::SQL::Window.new(partition: :a) # (PARTITION BY "a")
 
-  Sequel::SQL::Window.new(:partition=>:a, :frame=>:all)
+  Sequel::SQL::Window.new(partition: :a, frame: :all)
   # (PARTITION BY "a" ROWS BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING)
 
 === Sequel::SQL::Wrapper
@@ -564,7 +546,7 @@ Sequel::SQL::Wrapper objects wrap arbitrary objects so that they can be used
 in Sequel expressions:
 
   o = Object.new
-  def o.sql_literal(ds) "foo" end
+  def o.sql_literal_append(ds, sql) sql << "foo" end
   Sequel::SQL::Wrapper.new(o) # foo
 
 The advantage of wrapping the object is that you can the call Sequel methods

data/doc/opening_databases.rdoc

@@ -28,12 +28,12 @@ You can use URI query parameters to specify options:
 
 You can also pass an additional option hash with the connection string:
 
-  DB = Sequel.connect('postgres://localhost/blog', :user=>'user', :password=>'password')
+  DB = Sequel.connect('postgres://localhost/blog', user: 'user', password: 'password')
 
 You can also just use an options hash without a connection string.  If you do this, you must
 provide the adapter to use:
 
-  DB = Sequel.connect(:adapter=>'postgres', :host=>'localhost', :database=>'blog', :user=>'user', :password=>'password')
+  DB = Sequel.connect(adapter: 'postgres', host: 'localhost', database: 'blog', user: 'user', password: 'password')
 
 All of the above statements are equivalent.
 
@@ -43,12 +43,12 @@ The specialized adapter method is similar to Sequel.connect with an options hash
 automatically populates the :adapter option and assumes the first argument is the :database option,
 unless the first argument is a hash. So the following statements are equivalent to the previous statements.
 
-  DB = Sequel.postgres('blog', :host=>'localhost', :user=>'user', :password=>'password')
-  DB = Sequel.postgres(:host=>'localhost', :user=>'user', :password=>'password', :database=>'blog')
+  DB = Sequel.postgres('blog', host: 'localhost', user: 'user', password: 'password')
+  DB = Sequel.postgres(host: 'localhost', user: 'user', password: 'password', database: 'blog')
 
 Note that using an adapter method forces the use of the specified adapter, not a database type, even
 though some adapters have the same name as the database type.  So if you
-want to connect to SQLite, for example, you can do so using the sqlite, do, jdbc, and swift adapters.
+want to connect to SQLite, for example, you can do so using the sqlite, amalgalite, and jdbc adapters.
 If you want to connect to SQLite on JRuby using the jdbc adapter, you should not use <tt>Sequel.sqlite</tt>
 for example, as that uses the C-based sqlite3 gem. Instead, the <tt>Sequel.jdbc</tt> would be appropriate (though
 as mentioned below, using <tt>Sequel.connect</tt> is recommended instead of <tt>Sequel.jdbc</tt>). 
@@ -75,22 +75,29 @@ These options are shared by all adapters unless otherwise noted.
 
 :adapter :: The adapter to use
 :database :: The name of the database to which to connect
+:cache_schema :: Whether schema should be cached for this database (true by default)
+:default_string_column_size :: The default size for string columns (255 by default)
 :host :: The hostname of the database server to which to connect
+:keep_reference :: Whether to keep a reference to the database in Sequel::DATABASES (true by default)
 :loggers :: An array of SQL loggers to log to
+:log_connection_info :: Whether to include connection information in log messages (false by default)
+:log_warn_duration :: The amount of seconds after which the queries are logged at :warn level
 :password :: The password for the user account
 :servers :: A hash with symbol keys and hash or proc values, used with master/slave/partitioned database configurations
-:single_threaded :: Whether to use a single-threaded (non-thread safe) connection pool
-:test :: Whether to test that a valid database connection can be made (false by default)
+:sql_log_level :: The level at which to issue queries to the loggers (:info by default)
+:test :: Whether to test that a valid database connection can be made (true by default)
 :user :: The user account name to use logging in
 
 The following options can be specified and are passed to the database's internal connection pool.
 
 :after_connect :: A callable object called after each new connection is made, with the
                   connection object (and server argument if the callable accepts 2 arguments),
-                  useful for customizations that you want to apply to all connections (default: nil).
-:max_connections :: The maximum size of the connection pool (default: 4 connections on most databases)
-:pool_sleep_time :: The number of seconds to sleep before trying to acquire a connection again (default: 0.001 seconds)
-:pool_timeout :: The number of seconds to wait if a connection cannot be acquired before raising an error (default: 5 seconds)
+                  useful for customizations that you want to apply to all connections (nil by default).
+:max_connections :: The maximum size of the connection pool (4 connections by default on most databases)
+:pool_timeout :: The number of seconds to wait if a connection cannot be acquired before raising an error (5 seconds by default)
+:preconnect :: Whether to automatically make the maximum number of connections when setting up the pool.
+               Can be set to "concurrently" to connect in parallel.
+:single_threaded :: Whether to use a single-threaded (non-thread safe) connection pool
 
 == Adapter specific connection options
 
@@ -112,7 +119,6 @@ The following options are supported:
 :command_timeout :: Sets the time in seconds to wait while attempting
                     to execute a command before cancelling the attempt and generating
                     an error. Specifically, it sets the ADO CommandTimeout property.
-                    If this property is not set, the default of 30 seconds is used.
 :driver :: The driver to use in the ADO connection string.  If not provided, a default
            of "SQL Server" is used.
 :conn_string :: The full ADO connection string.  If this is provided,
@@ -133,11 +139,11 @@ Example connections:
   Sequel.connect('ado:///sequel_test?host=server%5cdb_instance')
   Sequel.connect('ado://user:password@server/database?host=server%5cdb_instance&provider=SQLNCLI10')
   # Access 2007
-  Sequel.ado(:conn_string=>'Provider=Microsoft.ACE.OLEDB.12.0;Data Source=drive:\\path\\filename.accdb')
+  Sequel.ado(conn_string: 'Provider=Microsoft.ACE.OLEDB.12.0;Data Source=drive:\\path\\filename.accdb')
   # Access 2000
-  Sequel.ado(:conn_string=>'Provider=Microsoft.Jet.OLEDB.4.0;Data Source=drive:\\path\\filename.mdb')
+  Sequel.ado(conn_string: 'Provider=Microsoft.Jet.OLEDB.4.0;Data Source=drive:\\path\\filename.mdb')
   # Excel 2000 (for table names, use a dollar after the sheet name, e.g. Sheet1$)
-  Sequel.ado(:conn_string=>'Provider=Microsoft.Jet.OLEDB.4.0;Data Source=drive:\\path\\filename.xls;Extended Properties=Excel 8.0;')
+  Sequel.ado(conn_string: 'Provider=Microsoft.Jet.OLEDB.4.0;Data Source=drive:\\path\\filename.xls;Extended Properties=Excel 8.0;')
 
 === amalgalite 
 
@@ -168,17 +174,12 @@ Requires: java
 
 Houses Sequel's JDBC support when running on JRuby.
 Support for individual database types is done using subadapters.
-There are currently subadapters for PostgreSQL, MySQL, SQLite, H2, HSQLDB, Derby,
-Oracle, MSSQL, JTDS, AS400, Progress, Firebird, Informix, and DB2.
-For PostgreSQL, MySQL, SQLite, H2, HSQLDB, Derby, AS400 and JTDS,
-this can use the `jdbc-*` gem, for the others you need to have the `.jar` in your CLASSPATH
+There are currently subadapters for DB2, Derby, H2, HSQLDB, JTDS,
+MySQL, Oracle, PostgreSQL, SQLAnywhere, SQLite, and SQL Server.
+For Derby, H2, HSQLDB, JTDS, MySQL, Postgres, SQLite3
+the adapters can use the `jdbc-*` gem, for the others you need to have the `.jar` in your CLASSPATH
 or load the Java class manually before calling Sequel.connect.
 
-You just use the JDBC connection string directly, which can be specified
-via the string given to Sequel.connect or via the :uri, :url, or :database options.
-Sequel does no preprocessing of the string, it passes it directly to JDBC.
-So if you have problems getting a connection string to work, look up the JDBC
-documentation.
 
 Note that when using a JDBC adapter, the best way to use Sequel
 is via Sequel.connect, NOT Sequel.jdbc.  Use the JDBC connection
@@ -189,6 +190,10 @@ SQLite you do not need 2 preceding slashes for the database name
 (use no preceding slashes for a relative path, and one preceding
 slash for an absolute path).
 
+Sequel does no preprocessing of JDBC connection strings, it passes them directly to JDBC.
+So if you have problems getting a connection string to work, look up the 
+documentation for the JDBC driver.
+
 Example connection strings:
 
   jdbc:sqlite::memory:
@@ -218,8 +223,11 @@ The following additional options are supported:
            and only helps cases where <tt>java.sql.DriverManager.getConnection</tt> does not
            return a connection.
 :login_timeout :: Set the login timeout on the JDBC connection (in seconds).
+:jdbc_properties :: A hash for properties to set, skips the normal connection process of using
+                    java.sql.drivermanager.getconnection and tries the backup process of using
+                    driver.new.connect for the appropriate driver.
 
-There are a few issues with specific jdbc drivers:
+There are a few issues with specific jdbc driver gems:
 
 jdbc-h2 :: jdbc-h2 versions greater than 1.3.175 have issues with ORDER BY not working correctly in some cases.
 jdbc-postgres :: jdbc-postgres 9.4.1204 has issues using PostgreSQL-specific types in bound variables.
@@ -229,15 +237,14 @@ jdbc-postgres :: jdbc-postgres 9.4.1204 has issues using PostgreSQL-specific typ
 
 Requires: mysqlplus (or mysql if mysqlplus is not available)
 
-The MySQL adapter does not support the pure-ruby MySQL adapter that used to ship with
-ActiveRecord, it requires the native adapter.
+The MySQL adapter does not support the pure-ruby mysql.rb driver, it requires the C-extension driver.
 
 The following additional options are supported:
 
 :auto_is_null :: If set to true, makes "WHERE primary_key IS NULL" select the last inserted id.
 :charset :: Same as :encoding, :encoding takes precedence.
 :compress :: Whether to compress data sent/received via the socket connection.
-:config_default_group :: The default group to read from the in the MySQL config file.
+:config_default_group :: The default group to read from the in the MySQL config file, defaults to "client")
 :config_local_infile :: If provided, sets the Mysql::OPT_LOCAL_INFILE option on the connection with the given value.
 :encoding :: Specify the encoding/character set to use for the connection.
 :fractional_seconds :: On MySQL 5.6.5+, this option is recognized and will include fractional seconds in
@@ -251,6 +258,9 @@ The following additional options are supported:
 :read_timeout :: Set the timeout in seconds for reading back results to a query.
 :connect_timeout :: Set the timeout in seconds before a connection attempt is abandoned.
 
+The :sslkey, :sslcert, :sslca, :sslcapath, and :sslca options (in that order) are passed to Mysql#ssl_set method
+if either the :sslca or :sslkey option is given.
+
 === mysql2
 
 This is a newer MySQL adapter that does typecasting in C, so it is often faster than the
@@ -286,7 +296,7 @@ The following additional options are supported:
 
 Requires: pg (or postgres-pr/postgres-compat if pg is not available)
 
-The Sequel postgres adapter works with the pg, postgres, and postgres-pr ruby libraries.
+The Sequel postgres adapter works with the pg and postgres-pr ruby libraries.
 The pg library is the best supported, as it supports real bound variables and prepared statements.
 If the pg library is being used, Sequel will also attempt to load the sequel_pg library, which is
 a C extension that optimizes performance when Sequel is used with pg.  All users of Sequel who
@@ -386,6 +396,3 @@ Other Sequel specific options:
              This should be specified as an integer.  If you plan on setting large
              text or blob values via tinytds, you should use this option or modify
              your freetds.conf file.
-
-The Sequel tinytds adapter requires tiny_tds >= 0.4.5, and if you are using FreeTDS
-0.91, you must at least be using 0.91rc2 (0.91rc1 does not work).