abstract class Avram::Database

• Avram::Database
• Reference
• Object

Defined in:

Class Method Summary

• .close_connections!

  Close all available connections as well as the DB

• .connections
• .credentials
• .database_info : DatabaseInfo
• .delete

  Run a SQL DELETE on all tables in the database

• .exec(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#exec but with instrumentation

• .listen(*channels : String, &block : PQ::Notification -> ) : Nil

  Listens for pg_notify() calls on each channel in channels Yields a PQ::Notification object with channel, payload, and pid.

• .lock_id : UInt64 | Nil
• .lock_id=(lock_id : UInt64 | Nil)
• .query(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#query but with instrumentation

• .query(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args, &)

  Same as crystal-db's DB::QueryMethods#:query but with instrumentation

• .query_all(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#query_all but with instrumentation

• .query_all(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args, &)

  Same as crystal-db's DB::QueryMethods#:query_all but with instrumentation

• .query_each(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args, &)

  Same as crystal-db's DB::QueryMethods#:query_each but with instrumentation

• .query_one(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#query_one but with instrumentation

• .query_one(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args, &)

  Same as crystal-db's DB::QueryMethods#:query_one but with instrumentation

• .query_one?(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#query_one? but with instrumentation

• .query_one?(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args, &)

  Same as crystal-db's DB::QueryMethods#:"query_one?" but with instrumentation

• .rollback

  Rollback the current transaction

• .run(&)
• .scalar(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#scalar but with instrumentation

• .setup_connection(&block : DB::Connection -> Nil)
• .transaction(&)

  Wrap the block in a database transaction

• .truncate(**named_args)

  Run a SQL TRUNCATE on all tables in the database

• .verify_connection
• .with_lock_on(model : Avram::Model.class, mode : Avram::TableLockMode, &)

  Creates a lock on the table in mode AppDatabase.with_lock_on(User, mode: :row_exclusive) do user = UserQuery.new.id(1).for_update.first SaveUser.update!(user, name: "New Name") end

Instance Method Summary

• #exec(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#exec but with instrumentation

• #publish_query_event(query, args_, args, queryable, &)
• #query(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#query but with instrumentation

• #query(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args, &)

  Same as crystal-db's DB::QueryMethods#:query but with instrumentation

• #query_all(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#query_all but with instrumentation

• #query_all(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args, &)

  Same as crystal-db's DB::QueryMethods#:query_all but with instrumentation

• #query_each(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args, &)

  Same as crystal-db's DB::QueryMethods#:query_each but with instrumentation

• #query_one(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#query_one but with instrumentation

• #query_one(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args, &)

  Same as crystal-db's DB::QueryMethods#:query_one but with instrumentation

• #query_one?(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#query_one? but with instrumentation

• #query_one?(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args, &)

  Same as crystal-db's DB::QueryMethods#:"query_one?" but with instrumentation

• #scalar(query, *args_, args : Array | Nil = nil, queryable : String | Nil = nil, **named_args)

  Same as crystal-db's DB::QueryMethods#scalar but with instrumentation

Class Method Detail

# pg_notify("callback", "123")
AppDatabase.listen("callback", "jobs") do |notification|
  notification.channel # => "callback"
  notification.payload # => "123"
end

AppDatabase.transaction do
  # Create, read, update
  # Force a rollback with AppDatabase.rollback
end

AppDatabase.with_lock_on(User, mode: :row_exclusive) do
  user = UserQuery.new.id(1).for_update.first
  SaveUser.update!(user, name: "New Name")
end

Instance Method Detail