sequel 3.48.0 → 4.0.0

data/lib/sequel/database.rb

@@ -13,6 +13,7 @@ module Sequel
   # The Database class is meant to be subclassed by database adapters in order
   # to provide the functionality needed for executing queries.
   class Database
+    OPTS = Sequel::OPTS
   end
 
   require(%w"connecting dataset dataset_defaults logging features misc query transactions schema_generator schema_methods", 'database')

data/lib/sequel/database/connecting.rb

@@ -45,7 +45,7 @@ module Sequel
     end
     
     # Connects to a database.  See Sequel.connect.
-    def self.connect(conn_string, opts = {})
+    def self.connect(conn_string, opts = OPTS)
       case conn_string
       when String
         if match = /\A(jdbc|do):/o.match(conn_string)
@@ -138,12 +138,6 @@ module Sequel
       end
     end
 
-    # Connects to the database. This method should be overridden by descendants.
-    def connect(server)
-      Sequel::Deprecation.deprecate('Database#connect default implementation and Sequel::NotImplemented', 'All database instance can be assumed to implement connect.')
-      raise NotImplemented, "#connect should be overridden by adapters"
-    end
-    
     # The database type for this database object, the same as the adapter scheme
     # by default.  Should be overridden in adapters (especially shared adapters)
     # to be the correct type, so that even if two separate Database objects are
@@ -167,7 +161,7 @@ module Sequel
     #   DB.disconnect # All servers
     #   DB.disconnect(:servers=>:server1) # Single server
     #   DB.disconnect(:servers=>[:server1, :server2]) # Multiple servers
-    def disconnect(opts = {})
+    def disconnect(opts = OPTS)
       pool.disconnect(opts)
     end
 

data/lib/sequel/database/dataset.rb

@@ -24,13 +24,8 @@ module Sequel
     #
     #   DB.dataset # SELECT *
     #   DB.dataset.from(:items) # SELECT * FROM items
-    def dataset(opts=(no_arg_given=true; nil))
-      # REMOVE40
-      if no_arg_given
-        @dataset_class.new(self)
-      else
-        @dataset_class.new(self, opts)
-      end
+    def dataset
+      @dataset_class.new(self)
     end
 
     # Fetches records for an arbitrary SQL statement. If a block is given,

data/lib/sequel/database/dataset_defaults.rb

@@ -44,19 +44,6 @@ module Sequel
     # The identifier output method to use by default for this database (default: adapter default)
     attr_reader :identifier_output_method
 
-    # REMOVE40
-    def _default_schema
-      @default_schema
-    end
-    def default_schema
-      Sequel::Deprecation.deprecate('Database#default_schema', 'Use qualified tables instead')
-      @default_schema
-    end
-    def default_schema=(v)
-      Sequel::Deprecation.deprecate('Database#default_schema=', 'Use qualified tables instead') if v
-      @default_schema = v
-    end
-
     # If the database has any dataset modules associated with it,
     # use a subclass of the given class that includes the modules
     # as the dataset class.
@@ -146,11 +133,6 @@ module Sequel
       self.class.const_get(:DatasetClass)
     end
 
-    # REMOVE40
-    def default_schema_default
-      nil
-    end
-
     # Reset the default dataset used by most Database methods that
     # create datasets.  Usually done after changes to the identifier
     # mangling methods.

data/lib/sequel/database/features.rb

@@ -39,12 +39,12 @@ module Sequel
     # Whether the database supports Database#foreign_key_list for
     # parsing foreign keys.
     def supports_foreign_key_parsing?
-      [:access, :mssql, :mysql, :postgres, :sqlite].include?(database_type)
+      respond_to?(:foreign_key_list)
     end
 
     # Whether the database supports Database#indexes for parsing indexes.
     def supports_index_parsing?
-      [:access, :cubrid, :db2, :mssql, :mysql, :postgres, :sqlite].include?(database_type) || adapter_scheme == :jdbc
+      respond_to?(:indexes)
     end
 
     # Whether the database and adapter support prepared transactions
@@ -71,12 +71,12 @@ module Sequel
 
     # Whether the database supports Database#tables for getting list of tables.
     def supports_table_listing?
-      [:access, :cubrid, :db2, :firebird, :mssql, :mysql, :oracle, :postgres, :sqlite].include?(database_type) || adapter_scheme == :jdbc
+      respond_to?(:tables)
     end
     #
     # Whether the database supports Database#views for getting list of views.
     def supports_view_listing?
-      supports_table_listing?
+      respond_to?(:views)
     end
 
     # Whether the database and adapter support transaction isolation levels, false by default.

data/lib/sequel/database/misc.rb

@@ -110,7 +110,7 @@ module Sequel
     # :sql_log_level :: Method to use to log SQL to a logger, :info by default.
     #
     # All options given are also passed to the connection pool.
-    def initialize(opts = {}, &block)
+    def initialize(opts = OPTS, &block)
       @opts ||= opts
       @opts = connection_pool_default_options.merge(@opts)
       @loggers = Array(@opts[:logger]) + Array(@opts[:loggers])
@@ -121,7 +121,6 @@ module Sequel
       
       @opts[:single_threaded] = @single_threaded = typecast_value_boolean(@opts.fetch(:single_threaded, Database.single_threaded))
       @schemas = {}
-      @default_schema = @opts.fetch(:default_schema, default_schema_default)
       @default_string_column_size = @opts[:default_string_column_size] || DEFAULT_STRING_COLUMN_SIZE
       @prepared_statements = {}
       @transactions = {}
@@ -150,7 +149,7 @@ module Sequel
     # in progress transaction commits (and only if it commits).
     # Options:
     # :server :: The server/shard to use.
-    def after_commit(opts={}, &block)
+    def after_commit(opts=OPTS, &block)
       raise Error, "must provide block to after_commit" unless block
       synchronize(opts[:server]) do |conn|
         if h = _trans(conn)
@@ -167,7 +166,7 @@ module Sequel
     # in progress transaction rolls back (and only if it rolls back).
     # Options:
     # :server :: The server/shard to use.
-    def after_rollback(opts={}, &block)
+    def after_rollback(opts=OPTS, &block)
       raise Error, "must provide block to after_rollback" unless block
       synchronize(opts[:server]) do |conn|
         if h = _trans(conn)
@@ -212,7 +211,7 @@ module Sequel
     # Return true if already in a transaction given the options,
     # false otherwise.  Respects the :server option for selecting
     # a shard.
-    def in_transaction?(opts={})
+    def in_transaction?(opts=OPTS)
       synchronize(opts[:server]){|conn| !!_trans(conn)}
     end
 
@@ -398,7 +397,7 @@ module Sequel
     
     # Convert the given exception to an appropriate Sequel::DatabaseError
     # subclass, keeping message and traceback.
-    def raise_error(exception, opts={})
+    def raise_error(exception, opts=OPTS)
       if !opts[:classes] || Array(opts[:classes]).any?{|c| exception.is_a?(c)}
         raise Sequel.convert_exception_class(exception, database_error_class(exception, opts))
       else
@@ -495,8 +494,7 @@ module Sequel
     def typecast_value_string(value)
       case value
       when Hash, Array
-        Sequel::Deprecation.deprecate('Automatically typecasting a hash or array to string for a string column', 'Either typecast the input manually or use the looser_typecasting extension')
-        value.to_s
+        raise Sequel::InvalidValue, "invalid value for String: #{value.inspect}"
       else
         value.to_s
       end

data/lib/sequel/database/query.rb

@@ -36,53 +36,27 @@ module Sequel
       prepared_statement(ps_name).call(hash, &block)
     end
     
-    # Executes the given SQL on the database. This method should be overridden in descendants.
-    # This method should not be called directly by user code.
-    def execute(sql, opts={})
-      Sequel::Deprecation.deprecate('Database#execute default implementation and Sequel::NotImplemented', 'All database instances can be assumed to implement execute')
-      raise NotImplemented, "#execute should be overridden by adapters"
-    end
-    
     # Method that should be used when submitting any DDL (Data Definition
     # Language) SQL, such as +create_table+.  By default, calls +execute_dui+.
     # This method should not be called directly by user code.
-    def execute_ddl(sql, opts={}, &block)
+    def execute_ddl(sql, opts=OPTS, &block)
       execute_dui(sql, opts, &block)
     end
 
     # Method that should be used when issuing a DELETE, UPDATE, or INSERT
     # statement.  By default, calls execute.
     # This method should not be called directly by user code.
-    def execute_dui(sql, opts={}, &block)
+    def execute_dui(sql, opts=OPTS, &block)
       execute(sql, opts, &block)
     end
 
     # Method that should be used when issuing a INSERT
     # statement.  By default, calls execute_dui.
     # This method should not be called directly by user code.
-    def execute_insert(sql, opts={}, &block)
+    def execute_insert(sql, opts=OPTS, &block)
       execute_dui(sql, opts, &block)
     end
 
-    # Returns an array of hashes containing foreign key information from the
-    # table.  Each hash will contain at least the following fields:
-    #
-    # :columns :: An array of columns in the given table
-    # :table :: The table referenced by the columns
-    # :key :: An array of columns referenced (in the table specified by :table),
-    #         but can be nil on certain adapters if the primary key is referenced.
-    #
-    # The hash may also contain entries for:
-    #
-    # :deferrable :: Whether the constraint is deferrable
-    # :name :: The name of the constraint
-    # :on_delete :: The action to take ON DELETE
-    # :on_update :: The action to take ON UPDATE
-    def foreign_key_list(table, opts={})
-      Sequel::Deprecation.deprecate('Database#foreign_key_list default implementation and Sequel::NotImplemented', 'Use Database#supports_foreign_key_parsing? to check for support')
-      raise NotImplemented, "#foreign_key_list should be overridden by adapters"
-    end
-    
     # Returns a single value from the database, e.g.:
     #
     #   DB.get(1) # SELECT 1
@@ -92,26 +66,12 @@ module Sequel
       @default_dataset.get(*args, &block)
     end
     
-    # Return a hash containing index information for the table. Hash keys are index name symbols.
-    # Values are subhashes with two keys, :columns and :unique.  The value of :columns
-    # is an array of symbols of column names.  The value of :unique is true or false
-    # depending on if the index is unique.
-    #
-    # Should not include the primary key index, functional indexes, or partial indexes.
-    #
-    #   DB.indexes(:artists)
-    #   # => {:artists_name_ukey=>{:columns=>[:name], :unique=>true}}
-    def indexes(table, opts={})
-      Sequel::Deprecation.deprecate('Database#indexes default implementation and Sequel::NotImplemented', 'Use Database#supports_index_parsing? to check for support')
-      raise NotImplemented, "#indexes should be overridden by adapters"
-    end
-    
     # Runs the supplied SQL statement string on the database server. Returns nil.
     # Options:
     # :server :: The server to run the SQL on.
     #
     #   DB.run("SET some_server_variable = 42")
-    def run(sql, opts={})
+    def run(sql, opts=OPTS)
       execute_ddl(sql, opts)
       nil
     end
@@ -156,7 +116,7 @@ module Sequel
     #   #    :ruby_default=>nil,
     #   #    :db_type=>"text",
     #   #    :allow_null=>false}]]
-    def schema(table, opts={})
+    def schema(table, opts=OPTS)
       raise(Error, 'schema parsing is not implemented on this database') unless supports_schema_parsing?
 
       opts = opts.dup
@@ -218,22 +178,6 @@ module Sequel
       false
     end
 
-    # Return all tables in the database as an array of symbols.
-    #
-    #   DB.tables # => [:albums, :artists]
-    def tables(opts={})
-      Sequel::Deprecation.deprecate('Database#tables default implementation and Sequel::NotImplemented', 'Use Database#supports_table_listing? to check for support')
-      raise NotImplemented, "#tables should be overridden by adapters"
-    end
-    
-    # Return all views in the database as an array of symbols.
-    #
-    #   DB.views # => [:gold_albums, :artists_with_many_albums]
-    def views(opts={})
-      Sequel::Deprecation.deprecate('Database#views default implementation and Sequel::NotImplemented', 'Use Database#supports_view_listing? to check for support')
-      raise NotImplemented, "#views should be overridden by adapters"
-    end
-    
     private
     
     # Should raise an error if the table doesn't not exist,

data/lib/sequel/database/schema_generator.rb

@@ -108,7 +108,7 @@ module Sequel
       # :unique :: Mark the column as unique, generally has the same effect as
       #            creating a unique index on the column.
       # :unique_constraint_name :: The name to give the unique key constraint
-      def column(name, type, opts = {})
+      def column(name, type, opts = OPTS)
         columns << {:name => name, :type => type}.merge(opts)
         if index_opts = opts[:index]
           index(name, index_opts.is_a?(Hash) ? index_opts : {})
@@ -142,7 +142,7 @@ module Sequel
       #
       #   foreign_key([:artist_name, :artist_location], :artists, :name=>:artist_fk)
       #   # ADD CONSTRAINT artist_fk FOREIGN KEY (artist_name, artist_location) REFERENCES artists
-      def foreign_key(name, table=nil, opts = {})
+      def foreign_key(name, table=nil, opts = OPTS)
         opts = case table
         when Hash
           table.merge(opts)
@@ -160,11 +160,13 @@ module Sequel
       # Add a full text index on the given columns to the DDL.
       #
       # PostgreSQL specific options:
+      # :index_type :: Can be set to :gist to use a GIST index instead of the
+      #                default GIN index.
       # :language :: Set a language to use for the index (default: simple).
       #
       # Microsoft SQL Server specific options:
       # :key_index :: The KEY INDEX to use for the full text index.
-      def full_text_index(columns, opts = {})
+      def full_text_index(columns, opts = OPTS)
         index(columns, opts.merge(:type => :full_text))
       end
       
@@ -199,13 +201,13 @@ module Sequel
       #
       #   index [:artist_id, :name]
       #   # CREATE INDEX table_artist_id_name_index ON table (artist_id, name)
-      def index(columns, opts = {})
+      def index(columns, opts = OPTS)
         indexes << {:columns => Array(columns)}.merge(opts)
       end
       
       # Add a column with the given type, name, and opts to the DDL.  See +column+ for available
       # options.
-      def method_missing(type, name = nil, opts = {})
+      def method_missing(type, name = nil, opts = OPTS)
         name ? column(name, type, opts) : super
       end
 
@@ -250,7 +252,7 @@ module Sequel
       end
       
       # Add a spatial index on the given columns to the DDL.
-      def spatial_index(columns, opts = {})
+      def spatial_index(columns, opts = OPTS)
         index(columns, opts.merge(:type => :spatial))
       end
 
@@ -260,7 +262,7 @@ module Sequel
       #
       # Supports the same :deferrable option as #column. The :name option can be used
       # to name the constraint.
-      def unique(columns, opts = {})
+      def unique(columns, opts = OPTS)
         constraints << {:type => :unique, :columns => Array(columns)}.merge(opts)
       end
 
@@ -308,7 +310,7 @@ module Sequel
       # See CreateTableGenerator#column for the available options.
       #
       #   add_column(:name, String) # ADD COLUMN name varchar(255)
-      def add_column(name, type, opts = {})
+      def add_column(name, type, opts = OPTS)
         @operations << {:op => :add_column, :name => name, :type => type}.merge(opts)
       end
       
@@ -327,7 +329,7 @@ module Sequel
       #   add_unique_constraint(:name, :name=>:unique_name) # ADD CONSTRAINT unique_name UNIQUE (name)
       #
       # Supports the same :deferrable option as CreateTableGenerator#column.
-      def add_unique_constraint(columns, opts = {})
+      def add_unique_constraint(columns, opts = OPTS)
         @operations << {:op => :add_constraint, :type => :unique, :columns => Array(columns)}.merge(opts)
       end
 
@@ -353,14 +355,14 @@ module Sequel
       #               existing data has been cleaned up, validate_constraint can be used
       #               to mark the constraint as valid.  Note that this option only makes
       #               sense when using an array of columns.
-      def add_foreign_key(name, table, opts = {})
+      def add_foreign_key(name, table, opts = OPTS)
         return add_composite_foreign_key(name, table, opts) if name.is_a?(Array)
         add_column(name, Integer, {:table=>table}.merge(opts))
       end
       
       # Add a full text index on the given columns to the DDL for the table.
       # See CreateTableGenerator#index for available options.
-      def add_full_text_index(columns, opts = {})
+      def add_full_text_index(columns, opts = OPTS)
         add_index(columns, {:type=>:full_text}.merge(opts))
       end
       
@@ -368,7 +370,7 @@ module Sequel
       # CreateTableGenerator#index for available options.
       #
       #   add_index(:artist_id) # CREATE INDEX table_artist_id_index ON table (artist_id)
-      def add_index(columns, opts = {})
+      def add_index(columns, opts = OPTS)
         @operations << {:op => :add_index, :columns => Array(columns)}.merge(opts)
       end
       
@@ -378,7 +380,7 @@ module Sequel
       #
       #   add_primary_key(:id) # ADD COLUMN id serial PRIMARY KEY
       #   add_primary_key([:artist_id, :name]) # ADD PRIMARY KEY (artist_id, name)
-      def add_primary_key(name, opts = {})
+      def add_primary_key(name, opts = OPTS)
         return add_composite_primary_key(name, opts) if name.is_a?(Array)
         opts = @db.serial_primary_key_options.merge(opts)
         add_column(name, opts.delete(:type), opts)
@@ -386,7 +388,7 @@ module Sequel
       
       # Add a spatial index on the given columns to the DDL for the table.
       # See CreateTableGenerator#index for available options.
-      def add_spatial_index(columns, opts = {})
+      def add_spatial_index(columns, opts = OPTS)
         add_index(columns, {:type=>:spatial}.merge(opts))
       end
       
@@ -394,7 +396,7 @@ module Sequel
       #
       #   drop_column(:artist_id) # DROP COLUMN artist_id
       #   drop_column(:artist_id, :cascade=>true) # DROP COLUMN artist_id CASCADE
-      def drop_column(name, opts={})
+      def drop_column(name, opts=OPTS)
         @operations << {:op => :drop_column, :name => name}.merge(opts)
       end
       
@@ -405,7 +407,7 @@ module Sequel
       #
       #   drop_constraint(:unique_name) # DROP CONSTRAINT unique_name
       #   drop_constraint(:unique_name, :cascade=>true) # DROP CONSTRAINT unique_name CASCADE
-      def drop_constraint(name, opts={})
+      def drop_constraint(name, opts=OPTS)
         @operations << {:op => :drop_constraint, :name => name}.merge(opts)
       end
       
@@ -419,7 +421,7 @@ module Sequel
       #
       #   drop_foreign_key(:artist_id) # DROP CONSTRAINT table_artist_id_fkey, DROP COLUMN artist_id
       #   drop_foreign_key([:name]) # DROP CONSTRAINT table_name_fkey
-      def drop_foreign_key(name, opts={})
+      def drop_foreign_key(name, opts=OPTS)
         drop_composite_foreign_key(Array(name), opts)
         drop_column(name) unless name.is_a?(Array)
       end
@@ -439,14 +441,14 @@ module Sequel
       #   drop_index(:artist_id) # DROP INDEX table_artist_id_index
       #   drop_index([:a, :b]) # DROP INDEX table_a_b_index
       #   drop_index([:a, :b], :name=>:foo) # DROP INDEX foo
-      def drop_index(columns, options={})
+      def drop_index(columns, options=OPTS)
         @operations << {:op => :drop_index, :columns => Array(columns)}.merge(options)
       end
 
       # Modify a column's name in the DDL for the table.
       #
       #   rename_column(:name, :artist_name) # RENAME COLUMN name TO artist_name
-      def rename_column(name, new_name, opts = {})
+      def rename_column(name, new_name, opts = OPTS)
         @operations << {:op => :rename_column, :name => name, :new_name => new_name}.merge(opts)
       end
       
@@ -464,7 +466,7 @@ module Sequel
       # PostgreSQL specific options:
       #
       # :using :: Add a USING clause that specifies how to convert existing values to new values.
-      def set_column_type(name, type, opts={})
+      def set_column_type(name, type, opts=OPTS)
         @operations << {:op => :set_column_type, :name => name, :type => type}.merge(opts)
       end