abstract class PgORM::Base

• PgORM::Base
• ActiveModel::Model
• Reference
• Object

Included Modules

• ActiveModel::Callbacks
• ActiveModel::Validation
• PgORM::Associations
• PgORM::Persistence
• PgORM::Table
• PgORM::Validators

Extended Modules

• PgORM::ChangeReceiver
• PgORM::FullTextSearch
• PgORM::Query

Defined in:

Constant Summary

AM_PARENT_TYPE = {:type => PgORM::Base} of Nil => Nil

Log = ::Log.for(self)

TABLES = [] of String

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)
• .new(rs : DB::ResultSet)

Class Method Summary

• .attributes : Array(Symbol)

  Returns all attribute keys.

• .clear

  Removes all records from the table using DELETE.

• .create(**attributes)

  Creates and attempts to save a new record to the database.

• .create!(**attributes)

  Creates and saves a new record to the database.

• .delete(ids : Enumerable(Value))

  Deletes multiple records by an array of IDs.

• .delete(ids : Enumerable(Enumerable(Value)))

  Deletes multiple records with composite primary keys.

• .delete(*ids) : Nil

  Deletes one or more records by ID.

• .from_rs(rs : DB::ResultSet)
• .truncate(cascade = true)

  Quickly removes all records from the table using TRUNCATE.

• .update(id : Value, args) : Nil

  Updates one or more records by ID without loading them into memory.

• .update(id : Enumerable(Value), args) : Nil

  Updates multiple records by an array of IDs.

• .update(id : Enumerable(Enumerable(Value)), args) : Nil

  Updates multiple records with composite primary keys.

• .update(id, **args) : Nil

  Updates records using keyword arguments.

Macro Summary

• __customize_orm__
• __nilability_validation__
• default_primary_key(name, auto_generated = true, converter = nil, **tags)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #apply_defaults

  Generate code to apply default values

• #assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String))

  Assign to mulitple attributes via HTTP::Params.

• #assign_attributes(model : PgORM::Base)

  Assign to multiple attributes from a model object

• #assign_attributes

  Assign to multiple attributes.

• #attributes

  Returns a Hash of all attribute values

• #attributes_tuple

  Returns a NamedTuple of all attribute values.

• #extra_attributes : Hash(String, PgORM::Value)
• #persistent_attributes

  Returns a Hash of all attributes that can be persisted.

• #to_json(json : JSON::Builder)

Constructor Detail

Class Method Detail

User.clear # DELETE FROM users

user = User.create(name: "John", email: "[email protected]")
if user.persisted?
  puts "User created with ID: #{user.id}"
else
  puts "Failed to create user: #{user.errors}"
end

user = User.create!(name: "John", email: "[email protected]")
# => #<User id: 1, name: "John", email: "[email protected]">

# Raises PgORM::Error::RecordInvalid if validation fails
User.create!(name: "") # => Error!

User.delete([1, 2, 3, 4, 5])

CompositeModel.delete([{key1: "a", key2: 1}, {key1: "b", key2: 2}])

# Delete single record
User.delete(1)

# Delete multiple records
User.delete(1, 2, 3, 4, 5)

# Truncate just this table
User.truncate(cascade: false)

# Truncate and cascade to related tables
User.truncate(cascade: true) # Also truncates related records

# Update single record
User.update(1, {name: "John Updated"})
User.update(1, name: "John Updated")

# Update multiple records by ID
User.update([1, 2, 3], {active: false})

# Update with composite primary key
CompositeModel.update({key1: "a", key2: 1}, {status: "active"})

User.update([1, 2, 3], {active: false})

CompositeModel.update([{key1: "a", key2: 1}, {key1: "b", key2: 2}], {status: "active"})

User.update(1, name: "John", active: true)

Macro Detail

Instance Method Detail