Module: Cequel::Record

Extended by:

ActiveSupport::Concern, Forwardable

Defined in:

lib/cequel/record.rb,
lib/cequel/record/bound.rb,
lib/cequel/record/dirty.rb,
lib/cequel/record/errors.rb,
lib/cequel/record/schema.rb,
lib/cequel/record/scoped.rb,
lib/cequel/record/finders.rb,
lib/cequel/record/railtie.rb,
lib/cequel/record/callbacks.rb,
lib/cequel/record/collection.rb,
lib/cequel/record/conversion.rb,
lib/cequel/record/properties.rb,
lib/cequel/record/record_set.rb,
lib/cequel/record/bulk_writes.rb,
lib/cequel/record/persistence.rb,
lib/cequel/record/validations.rb,
lib/cequel/record/associations.rb,
lib/cequel/record/mass_assignment.rb,
lib/cequel/record/data_set_builder.rb,
lib/cequel/record/record_generator.rb,
lib/cequel/record/has_many_association.rb,
lib/cequel/record/association_collection.rb,
lib/cequel/record/belongs_to_association.rb,
lib/cequel/record/lazy_record_collection.rb,
lib/cequel/record/configuration_generator.rb

Overview

Cequel::Record is an active record-style data modeling library and object-row mapper. Model classes inherit from Cequel::Record, define their columns in the class definition, and have access to a full and robust set of read and write functionality.

Individual components are documented in their respective modules. See below for links.

Examples:

A Record class showing off many of the possibilities

class Post
  include Cequel::Record

  belongs_to :blog
  key :id, :timeuuid, auto: true
  column :title, :text
  column :body, :text
  column :author_id, :uuid, index: true
  set :categories

  has_many :comments, dependent: destroy

  after_create :notify_followers

  validates :title, presence: true

  def self.for_author(author_id)
    where(:author_id, author_id)
  end
end

See Also:

• Defining properties
• Collection columns
• Defining associations between records
• Creating, updating, and destroying records
• Updating and destroying records in bulk
• Loading records from the database
• Magic finder methods
• Mass-assignment protection and strong attributes
• Lifecycle hooks
• Validations
• Dirty attribute tracking

Defined Under Namespace

Modules: Associations, BulkWrites, Callbacks, ClassMethods, Collection, Conversion, Dirty, Finders, MassAssignment, Persistence, Properties, Schema, Scoped, Validations Classes: AssociationCollection, BelongsToAssociation, Bound, ClusteringColumnBound, ConfigurationGenerator, DataSetBuilder, HasManyAssociation, LazyRecordCollection, List, Map, PartitionKeyBound, Railtie, RecordGenerator, RecordSet, Set, TimeuuidBound

Constant Summary

MissingAttributeError =

Raised when attempting to access an attribute of a record when that attribute hasn’t been loaded

Since:

• 1.0.0

Class.new(ArgumentError)

UnknownAttributeError =

Raised when attempting to read or write an attribute that isn’t defined on the record

Since:

• 1.0.0

Class.new(ArgumentError)

RecordNotFound =

Raised when attempting to load a record by key when that record does not exist

Class.new(StandardError)

InvalidRecordConfiguration =

Raised when attempting to configure a record in a way that is not possible

Since:

• 1.0.0

Class.new(StandardError)

RecordInvalid =

Raised when attempting to save a record that is invalid

Class.new(StandardError)

IllegalQuery =

Raised when attempting to construct a RecordSet that cannot construct a valid CQL query

Since:

• 1.0.0

Class.new(StandardError)

MissingKeyError =

Raised when attempting to persist a Cequel::Record without defining all primary key columns

Since:

• 1.0.0

Class.new(StandardError)

Class Attribute Summary

• .connection ⇒ Metal::Keyspace

  The keyspace used for record persistence.

Class Method Summary

• .establish_connection(configuration) ⇒ void

  Establish a connection with the given configuration.

Class Attribute Details

.connection ⇒ Metal::Keyspace

Returns the keyspace used for record persistence.

Returns:

• (Metal::Keyspace) —

  the keyspace used for record persistence

# File 'lib/cequel/record.rb', line 106

def connection
  @connection
end

Class Method Details

.establish_connection(configuration) ⇒ void

This method returns an undefined value.

Establish a connection with the given configuration

Parameters:

• configuration (Options)

Options Hash (configuration):

• :host (String) — default: '127.0.0.1' —

  hostname of single Cassandra instance to connect to

• :port (Integer) — default: 9042 —

  port on which to connect to all specified hosts

• :hosts (Array<String>) —

  list of Cassandra instances to connect to (hostnames only)

• :username (String) —

  user to auth with (leave blank for no auth)

• :password (String) —

  password to auth with (leave blank for no auth)

• :keyspace (String) —

  name of keyspace to connect to

# File 'lib/cequel/record.rb', line 115

def establish_connection(configuration)
  self.connection = Cequel.connect(configuration)
end