diff --git a/api/0.4.2/DB.html b/api/0.4.2/DB.html
new file mode 100644
index 0000000..5570444
--- /dev/null
+++ b/api/0.4.2/DB.html
@@ -0,0 +1,703 @@
+
+
+
+ DB - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ module DB
+
+
+
+
+
+
+
+
Overview
+
+
The DB module is a unified interface to database access.
+Database dialects is supported by custom database driver shards.
+Check crystal-lang/crystal-sqlite3 for example.
+
+
Drivers implementors check Driver
+
+
DB manage a connection pool. The connection pool can be configured by URI query. See Database
+
+
Usage
+
+
Assuming crystal-sqlite3 is included a sqlite3 database can be opened with #open
+
+
db = DB .open "sqlite3:./path/to/db/file.db"
+db.close
+
+
If a block is given to #open
+
+
DB .open "sqlite3:./file.db" do | db|
+ # work with db
+end # db is closed
+
+
In the code above db is a Database QueryMethods
+
+
Three kind of statements can be performed:
+
+
Database#exec waits no response from the database.Database#scalar reads a single value of the response.Database#query returns a ResultSet that allows iteration over the rows in the response and column information.
+
+
All of the above methods allows parametrised query. Either positional or named arguments.
+
+
Check a full working version:
+
+
require "db"
+require "sqlite3"
+
+DB .open "sqlite3:./file.db" do | db|
+ db.exec "create table contacts (name string, age integer)"
+ db.exec "insert into contacts values (?, ?)" , "John Doe" , 30
+
+ args = [] of DB :: Any
+ args << "Sarah"
+ args << 33
+ db.exec "insert into contacts values (?, ?)" , args
+
+ puts "max age:"
+ puts db.scalar "select max(age) from contacts" # => 33
+
+ puts "contacts:"
+ db.query "select name, age from contacts order by age desc" do | rs|
+ puts " #{ rs.column_name(0 )} (#{ rs.column_name(1 )} )"# => name (age)
+ rs.each do
+ puts " #{ rs.read(String )} (#{ rs.read(Int32 )} )"# => Sarah (33)
+ # => John Doe (30)
+ end
+ end
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db.cr
+
+
+
+
+
db/pool.cr
+
+
+
+
+
db/string_key_cache.cr
+
+
+
+
+
db/query_methods.cr
+
+
+
+
+
db/session_methods.cr
+
+
+
+
+
db/disposable.cr
+
+
+
+
+
db/driver.cr
+
+
+
+
+
db/statement.cr
+
+
+
+
+
db/begin_transaction.cr
+
+
+
+
+
db/connection_context.cr
+
+
+
+
+
db/connection.cr
+
+
+
+
+
db/transaction.cr
+
+
+
+
+
db/pool_statement.cr
+
+
+
+
+
db/database.cr
+
+
+
+
+
db/pool_prepared_statement.cr
+
+
+
+
+
db/pool_unprepared_statement.cr
+
+
+
+
+
db/result_set.cr
+
+
+
+
+
db/error.cr
+
+
+
+
+
db/mapping.cr
+
+
+
+
+
spec.cr
+
+
+
+
+
db/version.cr
+
+
+
+
+
+
+
+
Constant Summary
+
+
+
+
+ TYPES = [Nil , String , Bool , Int32 , Int64 , Float32 , Float64 , Time , Bytes ]
+
+
+
+ Types supported to interface with database driver.
+These can be used in any ResultSet#read Database#query related
+method to be used as query parameters
+
+
+
+
+ VERSION = "0.4.2"
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
+
+
Macro Summary
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
connect (uri : URI | String)
+
+
#
+
+
+
Opens a connection using the specified uri .
+The scheme of the uri determines the driver to use.
+Returned connection must be closed by Connection#close.
+If a block is used the connection is yielded and closed automatically.
+
+
+
+
+
+
+
+
+ def self.
connect (uri : URI | String, &block)
+
+
#
+
+
+
Opens a connection using the specified uri .
+The scheme of the uri determines the driver to use.
+Returned connection must be closed by Connection#close.
+If a block is used the connection is yielded and closed automatically.
+
+
+
+
+
+
+
+
+ def self.
open (uri : URI | String)
+
+
#
+
+
+
Opens a database using the specified uri .
+The scheme of the uri determines the driver to use.
+Returned database must be closed by Database#close
+
+
+
+
+
+
+
+
+ def self.
open (uri : URI | String, &block)
+
+
#
+
+
+
Same as #open
+
+
+
+
+
+
+
+
+ def self.
register_driver (driver_name, driver_class : Driver.class)
+
+
#
+
+
+
Registers a driver class for a given driver_name .
+Should be called by drivers implementors only.
+
+
+
+
+
+
+
+
+
+
+
Macro Detail
+
+
+
+
+ macro
mapping (properties, strict = true)
+
+
#
+
+
+
The DB.mapping
+
+
It takes hash literal as argument, in which attributes and types are defined.
+Once defined, DB::ResultSet#read(t)
+
+
require "db"
+
+class Employee
+ DB .mapping({
+ title: String ,
+ name: String ,
+ })
+end
+
+employees = Employee .from_rs(db.query("SELECT title, name FROM employees" ))
+employees[0 ].title # => "Manager"
+employees[0 ].name # => "John"
+
+
Attributes not mapped with DB.mapping DB::Exception.
+
+
You can also define attributes for each property.
+
+
class Employee
+ DB .mapping({
+ title: String ,
+ name: {
+ type : String ,
+ nilable: true ,
+ key: "firstname" ,
+ },
+ })
+end
+
+
Available attributes:
+
+
type (required) defines its type. In the example above, title: String is a shortcut to title: {type: String} .nilable defines if a property can be a Nil.default : value to use if the property is missing in the result set, or if it's null and nilable was not set to true. If the default value creates a new instance of an object (for example [1, 2, 3] or SomeObject.new), a different instance will be used each time a row is parsed.key defines which column to read from a reusltset. It defaults to the name of the property.converter takes an alternate type for parsing. It requires a #from_rs method in that class, and returns an instance of the given type.
+
+
The mapping also automatically defines Crystal properties (getters and setters) for each
+of the keys. It doesn't define a constructor accepting those arguments, but you can provide
+an overload.
+
+
The macro basically defines a constructor accepting a DB::ResultSet
+
+
This macro also declares instance variables of the types given in the mapping.
+
+
+
+
+
+
+
+
+ macro
mapping
+
+
#
+
+
+
+
+
+
+
+
+
DB::Any - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ alias DB::Any
+
+
+
+
+
+
+
+
+
+
Alias Definition
+
Bool | Float32 | Float64 | Int32 | Int64 | Slice(UInt8) | String | Time | Nil
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db.cr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::BeginTransaction - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ module DB::BeginTransaction
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Direct including types
+
+
+
+
+
+
Defined in:
+
+
+
db/begin_transaction.cr
+
+
+
+
+
+
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+ def
transaction (&block)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::Connection - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ abstract class DB::Connection
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Database driver implementors must subclass Connection
+
+
Represents one active connection to a database.
+
+
Users should never instantiate a Connection DB#open Database#connection.
+
+
Refer to QueryMethods
+
+
Note to implementors
+
+
The connection must be initialized in #initialize and closed in #do_close.
+
+
Override #build_prepared_statement method in order to return a prepared Statement #build_unprepared_statement method in order to return a unprepared Statement Statement
+
+
If at any give moment the connection is lost a DB::ConnectionLost should be raised. This will
+allow the connection pool to try to reconnect or use another connection if available.
+
+
+
+
+
+
Included Modules
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/connection.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ begin_transaction : Transaction
+ begin_transaction ,
+
+
+
+ transaction(&block)
+ transaction
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ build(query) : Stmt
+ build ,
+
+
+
+ build_unprepared_statement(query) : Stmt
+ build_unprepared_statement ,
+
+
+
+ fetch_or_build_prepared_statement(query) : Stmt
+ fetch_or_build_prepared_statement ,
+
+
+
+ prepared(query)
+ prepared ,
+
+
+
+ prepared_statements? : Bool
+ prepared_statements? ,
+
+
+
+ unprepared(query)
+ unprepared
+
+
+
+
+
+
+
+
+
+
+
Instance methods inherited from module DB::QueryMethods
+
+
+
+ exec(query, *args)
+ exec ,
+
+
+
+ query(query, *args)
+ query ,
+
+
+
+ query_all(query, *args, &block : ResultSet -> U) : Array(U) forall U
+ query_all ,
+
+
+
+ query_each(query, *args, &block)
+ query_each ,
+
+
+
+ query_one(query, *args, &block : ResultSet -> U) : U forall U
+ query_one ,
+
+
+
+ query_one?(query, *args, &block : ResultSet -> U) : U? forall U
+ query_one? ,
+
+
+
+ scalar(query, *args)
+ scalar
+
+
+
+
+
+
+
+
+
+
+
Instance methods inherited from module DB::Disposable
+
+
+
+ close
+ close ,
+
+
+
+ closed?
+ closed?
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+ def
begin_transaction
+
+
#
+
+
+
+
+
+
+
+
+
+ def
prepared_statements? : Bool
+
+
#
+
+
+
+
+
+
+
+
+
+
return this connection to the pool
+managed by the database. Should be used
+only if the connection was obtained by Database#checkout
+
+
+
+
+
+
+
+
+
+
DB::ConnectionContext - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ module DB::ConnectionContext
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Direct including types
+
+
+
+
+
+
Defined in:
+
+
+
db/connection_context.cr
+
+
+
+
+
+
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+ abstract
+ def
discard (connection :
Connection )
+
+
#
+
+
+
Indicates that the connection was permanently closed
+and should not be used in the future.
+
+
+
+
+
+
+
+ abstract
+ def
prepared_statements? : Bool
+
+
#
+
+
+
Return whether the statements should be prepared by default
+
+
+
+
+
+
+
+ abstract
+ def
release (connection :
Connection )
+
+
#
+
+
+
Indicates that the connection is no longer needed
+and can be reused in the future.
+
+
+
+
+
+
+
+ abstract
+ def
uri : URI
+
+
#
+
+
+
Returns the uri with the connection settings to the database
+
+
+
+
+
+
+
+
+
+
DB::ConnectionLost - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::ConnectionLost
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Raised when an established connection is lost
+probably due to socket/network issues.
+It is used by the connection pool retry logic.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/error.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (connection)
+
+
#
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+
+
DB::ConnectionRefused - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::ConnectionRefused
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Raised when a connection is unable to be established
+probably due to socket/network or configuration issues.
+It is used by the connection pool retry logic.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/error.cr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::Database - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::Database
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Acts as an entry point for database access.
+Connections are managed by a pool.
+The connection pool can be configured from URI parameters:
+
+
initial_pool_size (default 1) max_pool_size (default 0 = unlimited) max_idle_pool_size (default 1) checkout_timeout (default 5.0) retry_attempts (default 1) retry_delay (in seconds, default 1.0)
+
+
When querying a database prepared statements are used by default.
+This can be changed from the prepared_statements URI parameter:
+
+
prepared_statements = true|false (default true)
+
+
It should be created from DB module. See DB#open
+
+
Refer to QueryMethods SessionMethods
+
+
+
+
+
+
Included Modules
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/database.cr
+
+
+
+
+
+
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ discard(connection : Connection)
+ discard ,
+
+
+
+ prepared_statements? : Bool
+ prepared_statements? ,
+
+
+
+ release(connection : Connection)
+ release ,
+
+
+
+ uri : URI
+ uri
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ build(query) : Stmt
+ build ,
+
+
+
+ build_unprepared_statement(query) : Stmt
+ build_unprepared_statement ,
+
+
+
+ fetch_or_build_prepared_statement(query) : Stmt
+ fetch_or_build_prepared_statement ,
+
+
+
+ prepared(query)
+ prepared ,
+
+
+
+ prepared_statements? : Bool
+ prepared_statements? ,
+
+
+
+ unprepared(query)
+ unprepared
+
+
+
+
+
+
+
+
+
+
+
Instance methods inherited from module DB::QueryMethods
+
+
+
+ exec(query, *args)
+ exec ,
+
+
+
+ query(query, *args)
+ query ,
+
+
+
+ query_all(query, *args, &block : ResultSet -> U) : Array(U) forall U
+ query_all ,
+
+
+
+ query_each(query, *args, &block)
+ query_each ,
+
+
+
+ query_one(query, *args, &block : ResultSet -> U) : U forall U
+ query_one ,
+
+
+
+ query_one?(query, *args, &block : ResultSet -> U) : U? forall U
+ query_one? ,
+
+
+
+ scalar(query, *args)
+ scalar
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
returns a connection from the pool
+the returned connection must be returned
+to the pool by explictly calling Connection#release
+
+
+
+
+
+
+
+
+
Closes all connection to the database.
+
+
+
+
+
+
+
+
+ def
prepared_statements? : Bool
+
+
#
+
+
+
+
+
+
+
+
+
+ def
setup_connection (&proc :
Connection -> Nil)
+
+
#
+
+
+
+
+
+
+
+
+
+ def
transaction (&block)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+ def
uri : URI
+
+
#
+
+
+
Returns the uri with the connection settings to the database
+
+
+
+
+
+
+
+
+ def
using_connection (&block)
+
+
#
+
+
+
yields a connection from the pool
+the connection is returned to the pool
+when the block ends
+
+
+
+
+
+
+
+
+
+
DB::Disposable - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ module DB::Disposable
+
+
+
+
+
+
+
+
Overview
+
+
Generic module to encapsulate disposable db resources.
+
+
+
+
+
+
+
+
+
+
+
+
Direct including types
+
+
+
+
+
+
Defined in:
+
+
+
db/disposable.cr
+
+
+
+
+
+
+
+
+
+
+
Instance Method Summary
+
+
+
+ #close
+
+
+ #closed? Returns true if this object is closed.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+
Returns true if this object is closed. See #close
+
+
+
+
+
+
+
+
+
+
DB::Driver - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ abstract class DB::Driver
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Database driver implementors must subclass Driver DB#register_driver #build_connection
+
+
require "db"
+
+class FakeDriver < DB :: Driver
+ def build_connection (context : DB :: ConnectionContext )
+ FakeConnection .new context
+ end
+end
+
+DB .register_driver "fake" , FakeDriver
+
+
Access to this fake datbase will be available with
+
+
DB .open "fake://..." do | db|
+ # ... use db ...
+end
+
+
Refer to Connection Statement ResultSet
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/driver.cr
+
+
+
+
+
+
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+ def
connection_pool_options (params : HTTP::Params)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
DB::DriverSpecs(DBAnyType) - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::DriverSpecs(DBAnyType)
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Helper class to ensure behaviour of custom drivers
+
+
require "db/spec"
+
+DB :: DriverSpecs (DB :: Any ).run do
+ # How to connect to database
+ connection_string "scheme://database_url"
+
+ # Clean up database if needed using before/after callbacks
+ before do
+ # ...
+ end
+
+ after do
+ # ...
+ end
+
+ # Sample values that will be stored, retrieved across many specs
+ sample_value "hello" , "varchar(25)" , "'hello'"
+
+ it "custom spec with a db initialized" do | db|
+ # assert something using *db*
+ end
+
+ # Configure the appropiate syntax for different commands needed to run the specs
+ binding_syntax do | index|
+ "?"
+ end
+
+ create_table_1column_syntax do | table_name, col1|
+ "create table #{ table_name} (#{ col1.name} #{ col1.sql_type} #{ col1.null ? "NULL" : "NOT NULL" } )"end
+end
+
+
The following methods needs to be called to configure the appropiate syntax
+for different commands and allow all the specs to run: #binding_syntax #create_table_1column_syntax #create_table_2columns_syntax #select_1column_syntax #select_2columns_syntax #select_count_syntax #select_scalar_syntax #insert_1column_syntax #insert_2columns_syntax #drop_table_if_exists_syntax
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
spec.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+ #after (&after : -> Nil)
+
+
+ #before (&before : -> Nil)
+
+
+ #binding_syntax (&binding_syntax : Proc(Int32, String))
+
+
+ #connection_string (connection_string : String)
+
+
+ #create_table_1column_syntax (&create_table_1column_syntax : Proc(String, ColumnDef, String))
+
+
+ #create_table_2columns_syntax (&create_table_2columns_syntax : Proc(String, ColumnDef, ColumnDef, String))
+
+
+ #drop_table_if_exists_syntax (&drop_table_if_exists_syntax : Proc(String, String))
+
+
+ #encode_null (encode_null : String)
+
+
+ #insert_1column_syntax (&insert_1column_syntax : Proc(String, ColumnDef, String, String))
+
+
+ #insert_2columns_syntax (&insert_2columns_syntax : Proc(String, ColumnDef, String, ColumnDef, String, String))
+
+
+ #it (description = "assert" , prepared = :default , file = __FILE__, line = __LINE__, end_line = __END_LINE__, &block : DB::Database -> )
+
+
+ #its
+
+
+ #sample_value (value, sql_type, value_encoded, *, type_safe_value = true )Use value as sample value that should be stored in columns of type sql_type .
+
+
+ #select_1column_syntax (&select_1column_syntax : Proc(String, ColumnDef, String))
+
+
+ #select_2columns_syntax (&select_2columns_syntax : Proc(String, ColumnDef, ColumnDef, String))
+
+
+ #select_count_syntax (&select_count_syntax : Proc(String, String))
+
+
+ #select_scalar_syntax (&select_scalar_syntax : Proc(String, String?, String))
+
+
+ #support_prepared (support_prepared : Bool)Allow specs that uses prepared statements (default true)
+
+
+ #support_unprepared (support_unprepared : Bool)Allow specs that uses unprepared statements (default true)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
run (description =
"as a db" , &block)
+
+
#
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+ def
after (&after : -> Nil)
+
+
#
+
+
+
+
+
+
+
+
+
+ def
before (&before : -> Nil)
+
+
#
+
+
+
+
+
+
+
+
+
+ def
binding_syntax (&binding_syntax : Proc(Int32, String))
+
+
#
+
+
+
+
+
+
+
+
+
+ def
connection_string (connection_string : String)
+
+
#
+
+
+
+
+
+
+
+
+
+ def
create_table_1column_syntax (&create_table_1column_syntax : Proc(String,
ColumnDef , String))
+
+
#
+
+
+
+
+
+
+
+
+
+ def
create_table_2columns_syntax (&create_table_2columns_syntax : Proc(String,
ColumnDef ,
ColumnDef , String))
+
+
#
+
+
+
+
+
+
+
+
+
+ def
drop_table_if_exists_syntax (&drop_table_if_exists_syntax : Proc(String, String))
+
+
#
+
+
+
+
+
+
+
+
+
+ def
encode_null (encode_null : String)
+
+
#
+
+
+
+
+
+
+
+
+
+ def
insert_1column_syntax (&insert_1column_syntax : Proc(String,
ColumnDef , String, String))
+
+
#
+
+
+
+
+
+
+
+
+
+ def
insert_2columns_syntax (&insert_2columns_syntax : Proc(String,
ColumnDef , String,
ColumnDef , String, String))
+
+
#
+
+
+
+
+
+
+
+
+
+ def
it (description =
"assert" , prepared =
:default , file = __FILE__, line = __LINE__, end_line = __END_LINE__, &block :
DB::Database -> )
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+ def
sample_value (value, sql_type, value_encoded, *, type_safe_value =
true )
+
+
#
+
+
+
Use value as sample value that should be stored in columns of type sql_type .
+value_encoded is driver specific expression that should generate that value in the database.
+type_safe_value indicates whether value_encoded is expected to generate the value even without
+been stored in a table (default true).
+
+
+
+
+
+
+
+
+ def
select_1column_syntax (&select_1column_syntax : Proc(String,
ColumnDef , String))
+
+
#
+
+
+
+
+
+
+
+
+
+ def
select_2columns_syntax (&select_2columns_syntax : Proc(String,
ColumnDef ,
ColumnDef , String))
+
+
#
+
+
+
+
+
+
+
+
+
+ def
select_count_syntax (&select_count_syntax : Proc(String, String))
+
+
#
+
+
+
+
+
+
+
+
+
+ def
select_scalar_syntax (&select_scalar_syntax : Proc(String, String?, String))
+
+
#
+
+
+
+
+
+
+
+
+
+ def
support_prepared (support_prepared : Bool)
+
+
#
+
+
+
Allow specs that uses prepared statements (default true)
+
+
+
+
+
+
+
+
+ def
support_unprepared (support_unprepared : Bool)
+
+
#
+
+
+
Allow specs that uses unprepared statements (default true)
+
+
+
+
+
+
+
+
+
+
DB::DriverSpecs::ColumnDef - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ struct DB::DriverSpecs::ColumnDef
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
spec.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (name : String, sql_type : String, null : Bool)
+
+
#
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+ def
name : String
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+ def
null : Bool
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+ def
sql_type : String
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::Error - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::Error
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Direct Known Subclasses
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/error.cr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::ExecResult - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ struct DB::ExecResult
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Result of a #exec statement.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (rows_affected : Int64, last_insert_id : Int64)
+
+
#
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+ def
last_insert_id : Int64
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+ def
rows_affected : Int64
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::Mappable - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ module DB::Mappable
+
+
+
+
+
+
+
+
Overview
+
+
Empty module used for marking a class as supporting DB:Mapping
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/mapping.cr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::MappingException - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::MappingException
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/error.cr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::Pool(T) - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::Pool(T)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/pool.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (initial_pool_size =
1 , max_pool_size =
0 , max_idle_pool_size =
1 , checkout_timeout =
5.0 , retry_attempts =
1 , retry_delay =
0.2 , &factory : -> T)
+
+
#
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+ def
checkout : T
+
+
#
+
+
+
+
+
+
+
+
+
+ def
checkout_some (candidates : Enumerable(WeakRef(T))) : ::Tuple(T, Bool)
+
+
#
+
+
+
selected, is_candidate = pool.checkout_some(candidates)
+
+
selected be a resource from the candidates list and is_candidate == true
+or selected will be a new resource adn is_candidate == false
+
+
+
+
+
+
+
+
+ def
close : Nil
+
+
#
+
+
+
close all resources in the pool
+
+
+
+
+
+
+
+
+ def
release (resource : T) : Nil
+
+
#
+
+
+
+
+
+
+
+
+
+ def
retry (&block)
+
+
#
+
+
+
:nodoc:
+Will retry the block if a ConnectionLost retry_delay seconds delay.
+
+
+
+
+
+
+
+
+
+
DB::Pool::TimeoutHelper - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::Pool::TimeoutHelper
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/pool.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (timeout : Float64)
+
+
#
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+ def
receive_select_action
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::PoolPreparedStatement - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::PoolPreparedStatement
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Represents a statement to be executed in any of the connections
+of the pool. The statement is not be executed in a prepared fashion.
+The execution of the statement is retried according to the pool configuration.
+
+
See PoolStatement
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/pool_prepared_statement.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (db :
Database , query : String)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::PoolRetryAttemptsExceeded - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::PoolRetryAttemptsExceeded
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/error.cr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::PoolStatement - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ abstract class DB::PoolStatement
+
+
+
+
+
+
+
+
+
+
Overview
+
+
When a statement is to be executed in a DB that has a connection pool
+a statement from the DB needs to be able to represent a statement in any
+of the connections of the pool. Otherwise the user will need to deal with
+actual connections in some point.
+
+
+
+
+
+
Included Modules
+
+
+
+
+
+
+
Direct Known Subclasses
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/pool_statement.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (db :
Database , query : String)
+
+
#
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ def
scalar (*args)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::PoolTimeout - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::PoolTimeout
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/error.cr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::PoolUnpreparedStatement - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::PoolUnpreparedStatement
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Represents a statement to be executed in any of the connections
+of the pool. The statement is not be executed in a non prepared fashion.
+The execution of the statement is retried according to the pool configuration.
+
+
See PoolStatement
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/pool_unprepared_statement.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (db :
Database , query : String)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::QueryMethods - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ module DB::QueryMethods
+
+
+
+
+
+
+
+
Overview
+
+
Methods to allow querying a database.
+All methods accepts a query : String and a set arguments.
+
+
Three kind of statements can be performed:
+
+
#exec ExecResult #scalar #query ResultSet
+
+
Arguments can be passed by position
+
+
db.query("SELECT name FROM ... WHERE age > ?" , age)
+
+
Convention of mapping how arguments are mapped to the query depends on each driver.
+
+
Including QueryMethods build(query) : Statement method that is not expected
+to be called directly.
+
+
+
+
+
+
+
+
+
+
+
+
Direct including types
+
+
+
+
+
+
Defined in:
+
+
+
db/query_methods.cr
+
+
+
+
+
+
+
+
+
+
+
Instance Method Summary
+
+
+
+ #exec (query, *args)
+
+
+ #query (query, *args)Executes a query and returns a ResultSet
+
+
+ #query (query, *args, &block)Executes a query and yields a ResultSet
+
+
+ #query_all (query, *args, &block : ResultSet -> U) : Array(U) forall UExecutes a query and yield a ResultSet
+
+
+ #query_all (query, *args, as types : Tuple)Executes a query and returns an array where each row is read as a tuple of the given types .
+
+
+ #query_all (query, *args, as type : Class)Executes a query and returns an array where there first column's value of each row is read as the given type .
+
+
+ #query_each (query, *args, &block)Executes a query and yields the ResultSet
+
+
+ #query_one (query, *args, &block : ResultSet -> U) : U forall UExecutes a query that expects a single row and yields a ResultSet
+
+
+ #query_one (query, *args, as types : Tuple)Executes a query that expects a single row and returns it as a tuple of the given types .
+
+
+ #query_one (query, *args, as type : Class)Executes a query that expects a single row and returns the first column's value as the given type .
+
+
+ #query_one? (query, *args, &block : ResultSet -> U) : U? forall UExecutes a query that expects at most a single row and yields a ResultSet
+
+
+ #query_one? (query, *args, as types : Tuple)Executes a query that expects a single row and returns it as a tuple of the given types .
+
+
+ #query_one? (query, *args, as type : Class)Executes a query that expects a single row and returns the first column's value as the given type .
+
+
+ #scalar (query, *args)Performs the #query
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+ def
exec (query, *args)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+ def
query (query, *args)
+
+
#
+
+
+
Executes a query and returns a ResultSet ResultSet
+
+
result = db.query "select name from contacts where id = ?" , 10
+begin
+ if result.move_next
+ id = result.read(Int32 )
+ end
+ensure
+ result.close
+end
+
+
+
+
+
+
+
+
+ def
query (query, *args, &block)
+
+
#
+
+
+
Executes a query and yields a ResultSet ResultSet
+
+
db.query("select name from contacts where age > ?" , 18 ) do | rs|
+ rs.each do
+ name = rs.read(String )
+ end
+end
+
+
+
+
+
+
+
+
+ def
query_all (query, *args, &block :
ResultSet -> U) : Array(U) forall U
+
+
#
+
+
+
Executes a query and yield a ResultSet
+
+
names = db.query_all "select name from contacts" , & .read(String )
+
+
+
+
+
+
+
+
+ def
query_all (query, *args, as types : Tuple)
+
+
#
+
+
+
Executes a query and returns an array where each row is
+read as a tuple of the given types .
+
+
contacts = db.query_all "select name, age from contacts" , as : {String , Int32 }
+
+
+
+
+
+
+
+
+ def
query_all (query, *args, as type : Class)
+
+
#
+
+
+
Executes a query and returns an array where there first
+column's value of each row is read as the given type .
+
+
names = db.query_all "select name from contacts" , as : String
+
+
+
+
+
+
+
+
+ def
query_each (query, *args, &block)
+
+
#
+
+
+
Executes a query and yields the ResultSet ResultSet
+
+
db.query_each "select name from contacts" do | rs|
+ puts rs.read(String )
+end
+
+
+
+
+
+
+
+
+ def
query_one (query, *args, &block :
ResultSet -> U) : U forall U
+
+
#
+
+
+
Executes a query that expects a single row and yields a ResultSet
+
+
The given block must not invoke move_next on the yielded result set.
+
+
Raises DB::Error
+
+
name = db.query_one "select name from contacts where id = ?" , 18 , & .read(String )
+
+
+
+
+
+
+
+
+ def
query_one (query, *args, as types : Tuple)
+
+
#
+
+
+
Executes a query that expects a single row and returns it
+as a tuple of the given types .
+
+
Raises DB::Error
+
+
db.query_one "select name, age from contacts where id = ?" , 1 , as : {String , Int32 }
+
+
+
+
+
+
+
+
+ def
query_one (query, *args, as type : Class)
+
+
#
+
+
+
Executes a query that expects a single row
+and returns the first column's value as the given type .
+
+
Raises DB::Error
+
+
db.query_one "select name from contacts where id = ?" , 1 , as : String
+
+
+
+
+
+
+
+
+ def
query_one? (query, *args, &block :
ResultSet -> U) : U? forall U
+
+
#
+
+
+
Executes a query that expects at most a single row and yields a ResultSet
+
+
Returns nil, not invoking the block, if there were no rows.
+
+
Raises DB::Error
+
+
name = db.query_one? "select name from contacts where id = ?" , 18 , & .read(String )
+typeof (name) # => String | Nil
+
+
+
+
+
+
+
+
+ def
query_one? (query, *args, as types : Tuple)
+
+
#
+
+
+
Executes a query that expects a single row and returns it
+as a tuple of the given types .
+
+
Returns nil if there were no rows.
+
+
Raises DB::Error
+
+
result = db.query_one? "select name, age from contacts where id = ?" , 1 , as : {String , Int32 }
+typeof (result) # => Tuple(String, Int32) | Nil
+
+
+
+
+
+
+
+
+ def
query_one? (query, *args, as type : Class)
+
+
#
+
+
+
Executes a query that expects a single row
+and returns the first column's value as the given type .
+
+
Returns nil if there were no rows.
+
+
Raises DB::Error
+
+
name = db.query_one? "select name from contacts where id = ?" , 1 , as : String
+typeof (name) # => String?
+
+
+
+
+
+
+
+
+ def
scalar (query, *args)
+
+
#
+
+
+
Performs the #query
+
+
+
+
+
+
+
+
+
+
DB::ResultSet - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ abstract class DB::ResultSet
+
+
+
+
+
+
+
+
+
+
Overview
+
+
The response of a query performed on a Database
+
+
See DB
+
+
Each #read #move_next ResultSet #each #move_next
+
+
Note: depending on how the ResultSet #close. Check QueryMethods#query
+
+
Note to implementors
+
+
Override #move_next Override #read (Optional) Override #read(t) t for which custom logic other than a simple cast is needed. Override #column_count #column_name
+
+
+
+
+
+
Included Modules
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/result_set.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+ abstract
+ def
column_count : Int32
+
+
#
+
+
+
Returns the number of columns in the result
+
+
+
+
+
+
+
+ abstract
+ def
column_name (index : Int32) : String
+
+
#
+
+
+
Returns the name of the column in index 0-based position.
+
+
+
+
+
+
+
+
+ def
column_names
+
+
#
+
+
+
Returns the name of the columns.
+
+
+
+
+
+
+
+
+ def
each (&block)
+
+
#
+
+
+
Iterates over all the rows
+
+
+
+
+
+
+
+
+ def
each_column (&block)
+
+
#
+
+
+
Iterates over all the columns
+
+
+
+
+
+
+
+ abstract
+ def
move_next : Bool
+
+
#
+
+
+
Move the next row in the result.
+Return false if no more rows are available.
+See #each
+
+
+
+
+
+
+
+
+ def
read (type : DB::Mappable.class)
+
+
#
+
+
+
Reads the next columns and maps them to a class
+
+
+
+
+
+
+
+
+ def
read (type : T.class) : T forall T
+
+
#
+
+
+
Reads the next column value as a type
+
+
+
+
+
+
+
+ abstract
+ def
read
+
+
#
+
+
+
Reads the next column value
+
+
+
+
+
+
+
+
+ def
read (*types : Class)
+
+
#
+
+
+
Reads the next columns and returns a tuple of the values.
+
+
+
+
+
+
+
+
+
+
DB::Rollback - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::Rollback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/error.cr
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::SavePointTransaction - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::SavePointTransaction
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/transaction.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (parent :
Transaction , savepoint_name : String)
+
+
#
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+
+
+
+
+ def
create_save_point_transaction (parent :
Transaction )
+
+
#
+
+
+
+
+
+
+
+
+
+ def
release_from_nested_transaction
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::SessionMethods(Session, Stmt) - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ module DB::SessionMethods(Session, Stmt)
+
+
+
+
+
+
+
+
Overview
+
+
Methods that are shared accross session like objects:
+
+
+
+
Classes that includes this module are able to execute
+queries and statements in both prepared and unprepared fashion.
+
+
This module serves for dsl reuse over session like objects.
+
+
+
+
+
+
Included Modules
+
+
+
+
+
+
+
+
+
Direct including types
+
+
+
+
+
+
Defined in:
+
+
+
db/session_methods.cr
+
+
+
+
+
+
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
Instance methods inherited from module DB::QueryMethods
+
+
+
+ exec(query, *args)
+ exec ,
+
+
+
+ query(query, *args)
+ query ,
+
+
+
+ query_all(query, *args, &block : ResultSet -> U) : Array(U) forall U
+ query_all ,
+
+
+
+ query_each(query, *args, &block)
+ query_each ,
+
+
+
+ query_one(query, *args, &block : ResultSet -> U) : U forall U
+ query_one ,
+
+
+
+ query_one?(query, *args, &block : ResultSet -> U) : U? forall U
+ query_one? ,
+
+
+
+ scalar(query, *args)
+ scalar
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+ def
build (query) : Stmt
+
+
#
+
+
+
+
+
+
+
+
+ abstract
+ def
build_unprepared_statement (query) : Stmt
+
+
#
+
+
+
+
+
+
+
+
+ abstract
+ def
fetch_or_build_prepared_statement (query) : Stmt
+
+
#
+
+
+
+
+
+
+
+
+
+ def
prepared (query)
+
+
#
+
+
+
Returns a prepared Statement
+
+
+
+
+
+
+
+
+
dsl helper to build prepared statements
+returns a value that includes QueryMethods
+
+
+
+
+
+
+
+ abstract
+ def
prepared_statements? : Bool
+
+
#
+
+
+
Returns whether by default the statements should
+be prepared or not.
+
+
+
+
+
+
+
+
+ def
unprepared (query)
+
+
#
+
+
+
Returns an unprepared Statement
+
+
+
+
+
+
+
+
+ def
unprepared
+
+
#
+
+
+
dsl helper to build unprepared statements
+returns a value that includes QueryMethods
+
+
+
+
+
+
+
+
+
+
DB::SessionMethods::PreparedQuery(Session, Stmt) - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ struct DB::SessionMethods::PreparedQuery(Session, Stmt)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Included Modules
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/session_methods.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
Instance methods inherited from module DB::QueryMethods
+
+
+
+ exec(query, *args)
+ exec ,
+
+
+
+ query(query, *args)
+ query ,
+
+
+
+ query_all(query, *args, &block : ResultSet -> U) : Array(U) forall U
+ query_all ,
+
+
+
+ query_each(query, *args, &block)
+ query_each ,
+
+
+
+ query_one(query, *args, &block : ResultSet -> U) : U forall U
+ query_one ,
+
+
+
+ query_one?(query, *args, &block : ResultSet -> U) : U? forall U
+ query_one? ,
+
+
+
+ scalar(query, *args)
+ scalar
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (session : Session)
+
+
#
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+ def
build (query) : Stmt
+
+
#
+
+
+
+
+
+
+
+
+
+
+
DB::SessionMethods::UnpreparedQuery(Session, Stmt) - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ struct DB::SessionMethods::UnpreparedQuery(Session, Stmt)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Included Modules
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/session_methods.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
Instance methods inherited from module DB::QueryMethods
+
+
+
+ exec(query, *args)
+ exec ,
+
+
+
+ query(query, *args)
+ query ,
+
+
+
+ query_all(query, *args, &block : ResultSet -> U) : Array(U) forall U
+ query_all ,
+
+
+
+ query_each(query, *args, &block)
+ query_each ,
+
+
+
+ query_one(query, *args, &block : ResultSet -> U) : U forall U
+ query_one ,
+
+
+
+ query_one?(query, *args, &block : ResultSet -> U) : U? forall U
+ query_one? ,
+
+
+
+ scalar(query, *args)
+ scalar
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+ def self.
new (session : Session)
+
+
#
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+ def
build (query) : Stmt
+
+
#
+
+
+
+
+
+
+
+
+
+
+
DB::Statement - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ abstract class DB::Statement
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Represents a query in a Connection QueryMethods
+
+
Note to implementors
+
+
Subclass Statements Statements are created from a custom driver Connection#prepare method.#perform_query executes a query that is expected to return a ResultSet #perform_exec executes a query that is expected to return an ExecResult #do_close is called to release the statement resources.
+
+
+
+
+
+
Included Modules
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/statement.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+ def
exec (args : Array)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
+ def
exec (*args)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+ def
query (args : Array)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
+ def
query (*args)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+ def
release_connection
+
+
#
+
+
+
+
+
+
+
+
+
+
+
DB::StatementMethods - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ module DB::StatementMethods
+
+
+
+
+
+
+
+
Overview
+
+
Common interface for connection based statements
+and for connection pool statements.
+
+
+
+
+
+
Included Modules
+
+
+
+
+
+
+
+
+
Direct including types
+
+
+
+
+
+
Defined in:
+
+
+
db/statement.cr
+
+
+
+
+
+
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+ abstract
+ def
exec (args : Array) :
ExecResult
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ def
query (*args, &block)
+
+
#
+
+
+
+
+
+
+
+
+
+
+ abstract
+ def
query (args : Array) :
ResultSet
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ def
scalar (*args)
+
+
#
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::StringKeyCache(T) - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::StringKeyCache(T)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/string_key_cache.cr
+
+
+
+
+
+
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+ def
each_value (&block)
+
+
#
+
+
+
+
+
+
+
+
+
+ def
fetch (key : String, &block) : T
+
+
#
+
+
+
+
+
+
+
+
+
+
+
DB::TopLevelTransaction - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ class DB::TopLevelTransaction
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/transaction.cr
+
+
+
+
+
+
+
+
+
Class Method Summary
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
Class Method Detail
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
+
+
+
+
+
+
+
+
+
DB::Transaction - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+ abstract class DB::Transaction
+
+
+
+
+
+
+
+
+
+
Overview
+
+
Transactions should be started from DB#transaction, Connection#transaction
+or Connection#begin_transaction
+
+
Use Transaction#connection
+
+
Use Transaction#commit Transaction#rollback BeginTransaction#transaction #transaction(&block) methods in DB Connection
+
+
Nested transactions are supported by using sql SAVEPOINT. To start a nested
+transaction use Transaction#transaction or Transaction#begin_transaction.
+
+
+
+
+
+
Included Modules
+
+
+
+
+
+
+
Direct Known Subclasses
+
+
+
+
+
+
+
+
Defined in:
+
+
+
db/transaction.cr
+
+
+
+
+
+
+
+
+
+
+
Instance Method Summary
+
+
+
+
+
+
+
+
+
+
+
+
Instance Method Detail
+
+
+
+
+
commits the current transaction
+
+
+
+
+
+
+
+
+
+ abstract
+ def
release_from_nested_transaction
+
+
#
+
+
+
+
+
+
+
+
+
+
rollbacks the current transaction
+
+
+
+
+
+
+
+
+
+
README - github.com/crystal-lang/crystal-db
+
+
+
+
+
+
+
+
+
crystal-db
+
+
Common db api for crystal. You will need to a specific driver to access a database.
+
+
+
+
Installation
+
+
Add this to your application's shard.yml:
+
+
dependencies:
+ db:
+ github: crystal-lang/crystal-db
+
+
Documentation
+
+
+
+
Usage
+
+
Since this is an abstract db api, it's usage is through a concrete database driver.
+
+
require "db"
+require "sqlite3"
+
+DB .open "sqlite3:./file.db" do | db|
+ # When using the pg driver, use $1, $2, etc. instead of ?
+ db.exec "create table contacts (name string, age integer)"
+ db.exec "insert into contacts values (?, ?)" , "John Doe" , 30
+
+ args = [] of DB :: Any
+ args << "Sarah"
+ args << 33
+ db.exec "insert into contacts values (?, ?)" , args
+
+ puts "max age:"
+ puts db.scalar "select max(age) from contacts" # => 33
+
+ puts "contacts:"
+ db.query "select name, age from contacts order by age desc" do | rs|
+ puts " #{ rs.column_name(0 )} (#{ rs.column_name(1 )} )"# => name (age)
+ rs.each do
+ puts " #{ rs.read(String )} (#{ rs.read(Int32 )} )"# => Sarah (33)
+ # => John Doe (30)
+ end
+ end
+end
+
+
Roadmap
+
+
Issues not yet addressed
+
+
[x] Support non prepared statements. #25 [x] Time data type. (implementation details depends on actual drivers) [x] Data type extensibility. Allow each driver to extend the data types allowed. [x] Transactions & nested transactions. #27 [x] Connection pool. [ ] Direct access to IO to avoid memory allocation for blobs.
+
+
Contributing
+
+
Fork it ( https://github.com/crystal-lang/crystal-db/fork ) Create your feature branch (git checkout -b my-new-feature) Commit your changes (git commit -am 'Add some feature') Push to the branch (git push origin my-new-feature) Create a new Pull Request
+
+
Contributors
+
+
bcardiff Brian J. Cardiff - creator, maintainer
+
