abstract struct Cql::Record(Pk)

• Cql::Record(Pk)
• Struct
• Value
• Object

Overview

Write documentation for Record module

Example Using the Record module

AcmeDB = Cql::Schema.define(:acme_db, adapter: Cql::Adapter::Postgres,
  uri: "postgresql://example:example@localhost:5432/example") do
  table :posts do
    primary :id, Int64, auto_increment: true
    text :title
    text :body
    timestamp :published_at
  end

  table :comments do
    primary
    bigint :post_id
    text :body
  end
end

struct Post < Cql::Record(Int64)
  db_context AcmeDB, :posts

  getter id : Int64?
  getter title : String
  getter body : String
  getter published_at : Time

  def initialize(@title : String, @body : String, @published_at : Time = Time.utc)
  end
end

struct Comment < Cql::Record(Int64)
  db_context AcmeDB, :comments

  getter id : Int64?
  getter post_id : Int64
  getter body : String

  def initialize(@post_id : Int64, @body : String)
  end
end

Defined in:

Constructors

• .new

Instance Method Summary

• #attributes(attrs : Hash(Symbol, DB::Any))

  Set the record's attributes from a hash - @param attrs [Hash(Symbol, DB::Any)] The attributes to set - @return [Nil]

• #attributes

  Define instance-level methods for querying and manipulating data Fetch the record's ID or raise an error if it's nil - @return [PrimaryKey] The ID

• #delete

  Delete the record from the database - @return [Nil]

• #id

  Identity method for the record ID - @return [PrimaryKey] The ID

• #id=(id : Pk)

  Set the record's ID - @param id [PrimaryKey] The ID

• #initialize
• #persisted?

  Check if the record has been persisted to the database - @return [Bool] True if the record has an ID, false otherwise

• #reload!

  Define instance-level methods for querying and manipulating data Fetch the record's ID or raise an error if it's nil - @return [PrimaryKey] The ID

• #save

  Define instance-level methods for saving and deleting records Save the record to the database or update it if it already exists - @return [Nil]

• #update(fields : Hash(Symbol, DB::Any))

  Delete the record from the database if it exists - @return [Nil]

• #update

  Update the record with the given record object

• #update(**fields)

  Update the record with the given fields - @param fields [Hash(Symbol, DB::Any)] The fields to update - @return [Nil]

Constructor Detail

Instance Method Detail

user.attributes = {name: "Alice", email: "[email protected]"}

user.attributes
-> { id: 1, name: "Alice", email: " [email protected]" }

user.delete

user.id

user.id = 1

user.persisted?

user.reload!

user.save

user.delete

bob = User.new(name: "Bob", email: " [email protected]")
id = bob.save

bob.reload!
bon.name = "Juan"

bob.update

user.update(name: "Alice", email: " [email protected]")