README.md in cql_model-0.0.4 vs README.md in cql_model-0.0.5
- old
+ new
@@ -25,13 +25,13 @@
Cql::Base.establish_connection(host: '127.0.0.1')
class Person < Cql::Model
primary_key :id
- column :first_name, String
- column :last_name, String
- column :dob, Date
+ column :first_name
+ column :last_name
+ column :dob
end
### Schema Definition
While Cassandra doesn't get super picky about schemas you should understand how
@@ -46,19 +46,29 @@
primary_key :id
primary_key 'card_number'
#### Columns
-You define columns by supplying the attribute name, Ruby class for type
-conversion and an optional set of options.
+You define columns by supplying the attribute name and an optional set of
+options.
- column :first_name, String
- column :birth_date, Date
- column :birth_date, Date, column_name: :dob
+ column :first_name
+ column :birth_date
+ column :birth_date, column_name: :dob
The supported options for columns are as follows:
* `column_name`: actual column name for storing the attribute.
+* `ready_only`: flags the attribute as read-only, blocking creation of a setter
+ method.
+
+#### Consistency
+
+You can set any consistency value for your models that is supported by cql-rb
+and it will be passed whenever a query is executed. The default consistency
+level is `quorum`.
+
+ consistency :three
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)