Let's raise the visibility of code documentation in Ruby!
Inch CI is here! Make your own badge with the new CI service: http://inch-ci.org

cequel/cequel

Ruby ORM for Cassandra with CQL3 – Read the documentation

This page shows an evaluation of the documentation of cequel/cequel.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

Seems really good
A
Cequel::Metal::DataSet#delete
A
Cequel::Record::Map#merge!
A
Cequel::Metal::DataSet#select!
A
Cequel::Metal::DataSet#update
A
Cequel::Metal::Keyspace#clear_active_connections!
Show 367 more ...
A
Cequel::Record::Validations::ClassMethods#create!
A
Cequel::Record::LazyRecordCollection#load!
A
Cequel::Metal::DataSet#select_writetime
A
Cequel::Metal::DataSet#list_remove_at
A
Cequel::Metal::DataSet#map_remove
A
Cequel::Metal::DataSet#where!
A
Cequel::Metal::DataSet#where
A
Cequel::Record::List#unshift
A
Cequel::Record::List#push
A
Cequel::Record::Validations#save!
A
Cequel::Record::Validations#update_attributes!
A
Cequel::Schema::UpdateTableDSL#drop_index
A
Cequel::Schema::Keyspace#sync_table
A
Cequel::Record::Persistence#load!
A
Cequel::Schema::Keyspace#create!
A
Cequel::Record::RecordSet#where
A
Cequel::Record::RecordSet#count
A
Cequel::Schema::Keyspace#drop!
A
Cequel::Record::RecordSet#[]
A
Cequel::Metal::Row#writetime
A
Cequel::Record::List#[]=
A
Cequel::Metal::Keyspace
A
Cequel::Record::Map#[]=
A
Cequel::Record::Set#add
A
Cequel
A
Cequel::Schema::UpdateTableDSL#change_properties
A
Cequel::SpecSupport::Preparation.setup_database
A
Cequel::Record::Properties::ClassMethods#map
A
Cequel::Record::Persistence#key_values
A
Cequel::Metal::Deleter#list_remove_at
A
Cequel::Metal::Deleter#delete_columns
A
Cequel::Record::Schema::ClassMethods
A
Cequel::Metal::DataSet#list_replace
A
Cequel::Metal::DataSet#select_ttl
A
Cequel::Metal::Deleter#map_remove
A
Cequel::Metal::DataSet#decrement
A
Cequel::Metal::DataSet#increment
A
Cequel::Record::RecordSet#find
A
Cequel::Metal::DataSet#select
A
Cequel::Metal::DataSet
A
Cequel::Schema::Table
A
Cequel::Type
A
Cequel:: #partition_key_column_names
A
Cequel:: #child_associations
A
Cequel:: #parent_association
A
Cequel:: #association_key_columns
A
Cequel:: #association_class_name
A
Cequel:: #partition_key_columns
A
Cequel:: #association_class_name
A
Cequel::Record::Schema::ClassMethods#synchronize_schema
A
Cequel::Record::Schema::ClassMethods#clustering_columns
A
Cequel::Record::BelongsToAssociation#association_class
A
Cequel::Record::Schema::ClassMethods#key_column_names
A
Cequel::Record::HasManyAssociation#association_class
A
Cequel::Schema::ClusteringColumn#clustering_order
A
Cequel::Record::Schema::ClassMethods#column_names
A
Cequel::Record::Schema::ClassMethods#table_schema
A
Cequel::Record::Persistence::ClassMethods#create
A
Cequel::Record::Schema::ClassMethods#read_schema
A
Cequel::Schema::Table#partition_key_column_names
A
Cequel::Metal::Keyspace#execute_with_consistency
A
Cequel::SpecSupport::Preparation#create_keyspace
A
Cequel::Schema::Table#partition_key_column_count
A
Cequel::Record::Schema::ClassMethods#key_columns
A
Cequel::Record::BelongsToAssociation#owner_class
A
Cequel::Record::RecordSet#scoped_key_attributes
A
Cequel::Record::RecordSet#find_rows_in_batches
A
Cequel::SpecSupport::Preparation#drop_keyspace
A
Cequel::Record::HasManyAssociation#owner_class
A
Cequel::Schema::CreateTableDSL#compact_storage
A
Cequel::Schema::Table#clustering_column_names
A
Cequel::Schema::Table#clustering_column_count
A
Cequel::Schema::CreateTableDSL#partition_key
A
Cequel::Record::HasManyAssociation#dependent
A
Cequel::Record::Schema::ClassMethods#columns
A
Cequel::Metal::Keyspace#default_consistency=
A
Cequel::Schema::UpdateTableDSL#rename_column
A
Cequel::SpecSupport::Preparation#sync_schema
A
Cequel::Metal::Keyspace#default_consistency
A
Cequel::Schema::Table#partition_key_columns
A
Cequel::Schema::Table#add_clustering_column
A
Cequel::Schema::TableUpdater#rename_column
A
Cequel::Record::Persistence#key_attributes
A
Cequel::Record::Properties#attribute_names
A
Cequel::Record::Persistence::ClassMethods
A
Cequel::Record::BelongsToAssociation#name
A
Cequel::Metal::DataSet#row_specifications
A
Cequel::Record::Validations::ClassMethods
A
Cequel::Schema::UpdateTableDSL#add_column
A
Cequel::Schema::TableUpdater#create_index
A
Cequel::Record::Timestamps::ClassMethods
A
Cequel::Metal::DataSet#writetime_columns
A
Cequel::Schema::Table#clustering_columns
A
Cequel::Metal::DataSet#query_consistency
A
Cequel::Schema::Keyspace#truncate_table
A
Cequel::Schema::TableUpdater#add_column
A
Cequel::Schema::TableUpdater#drop_index
A
Cequel::Schema::UpdateTableDSL#add_list
A
Cequel::Record::HasManyAssociation#name
A
Cequel::Record::RecordSet#find_each_row
A
Cequel::Schema::Table#add_partition_key
A
Cequel::Schema::Table#key_column_count
A
Cequel::Schema::Table#compact_storage=
A
Cequel::Schema::Table#key_column_names
A
Cequel::Record::BulkWrites#destroy_all
A
Cequel::Record::RecordSet#target_class
A
Cequel::Record::Properties#attributes=
A
Cequel::Record::ConfigurationGenerator
A
Cequel::Record::Collection#column_name
A
Cequel::Schema::UpdateTableDSL#add_set
A
Cequel::Schema::UpdateTableDSL#add_map
A
Cequel::Schema::Keyspace#create_table
A
Cequel::Schema::TableUpdater#add_list
A
Cequel::Schema::DataColumn#index_name
A
Cequel::Metal::Keyspace#configuration
A
Cequel::Metal::DataSet#select_columns
A
Cequel::Record::BulkWrites#update_all
A
Cequel::Record::RecordSet#consistency
A
Cequel::Record::BulkWrites#delete_all
A
Cequel::Record::Properties#attributes
A
Cequel::Schema::Keyspace#alter_table
A
Cequel::Schema::TableUpdater#add_map
A
Cequel::Record::Scoped::ClassMethods
A
Cequel::Schema::TableProperty#to_cql
A
Cequel::Record::LazyRecordCollection
A
Cequel::Metal::Incrementer#increment
A
Cequel::Metal::Incrementer#decrement
A
Cequel::Schema::TableUpdater#add_set
A
Cequel::Record::RecordSet#values_at
A
Cequel::Schema::CompressionProperty
A
Cequel::Schema::Keyspace#drop_table
A
Cequel::Type::Base#compatible_types
A
Cequel::Metal::Keyspace#credentials
A
Cequel::Schema::TableProperty#name
A
Cequel::Record::RecordSet#data_set
A
Cequel::Schema::TableUpdater.apply
A
Cequel::Record::Properties#inspect
A
Cequel::Record::Collection#inspect
A
Cequel::Schema::Table#column_names
A
Cequel::Metal::DataSet#ttl_columns
A
Cequel::Schema::Table#data_columns
A
Cequel::Schema::CompactionProperty
A
Cequel::Metal::DataSet#table_name
A
Cequel::Metal::Deleter#delete_row
A
Cequel::Schema::TableWriter.apply
A
Cequel::Schema::Table#key_columns
A
Cequel::Metal::DataSet#sort_order
A
Cequel::Type::Base#internal_names
A
Cequel::SpecSupport::Preparation
A
Cequel::Schema::Table#properties
A
Cequel::Metal::DataSet#row_limit
A
Cequel::Record::Persistence#load
A
Cequel::Schema::TableReader.read
A
Cequel::Metal::DataSet#count_cql
A
Cequel::Schema::ClusteringColumn
A
Cequel::Record::RecordSet#select
A
Cequel::Metal::Keyspace.sanitize
A
Cequel::Record::RecordGenerator
A
Cequel::Metal::DataSet#keyspace
A
Cequel::Metal::Keyspace#execute
A
Cequel::Metal::Keyspace#schema
A
Cequel::Schema::Column#inspect
A
Cequel::Schema::UpdateTableDSL
A
Cequel::Record::List#delete_at
A
Cequel::Type::Base#cql_aliases
A
Cequel::Metal::Inserter#insert
A
Cequel::Record::RecordSet#each
A
Cequel::Schema::Table#columns
A
Cequel::Metal::Keyspace#hosts
A
Cequel::Record::Properties#==
A
Cequel::Metal::Keyspace#batch
A
Cequel::Schema::TableProperty
A
Cequel::Record::RecordSet#all
A
Cequel::Record::List#replace
A
Cequel::Schema::PartitionKey
A
Cequel::Metal::DataSet#first
A
Cequel::Record::RecordSet#at
A
Cequel::Schema::TableUpdater
A
Cequel::Record::Associations
A
Cequel::Metal::Keyspace#name
A
Cequel::Metal::DataSet#count
A
Cequel::Metal::DataSet#limit
A
Cequel::Schema::Map#key_type
A
Cequel::Schema::Column#type
A
Cequel::Record::Set#replace
A
Cequel::Schema::TableWriter
A
Cequel::Record::List#concat
A
Cequel::Record::Map#replace
A
Cequel::Schema::Column#to_s
A
Cequel::Schema::TableReader
A
Cequel::Schema::Column#name
A
Cequel::Record::List#delete
A
Cequel::Record::Persistence
A
Cequel::Record::List#clear
A
Cequel::Record::Map#delete
A
Cequel::Record.descendants
A
Cequel::Schema::Table#name
A
Cequel::Record::Set#delete
A
Cequel::Schema::DataColumn
A
Cequel::Record.connection=
A
Cequel::Metal::DataSet#cql
A
Cequel::Record::Timestamps
A
Cequel::Record.connection
A
Cequel::Record::Set#clear
A
Cequel::Record::Callbacks
A
Cequel::Record::Map#clear
A
Cequel::Schema::Column#==
A
Cequel::Record::RecordSet
A
Cequel::Record::Finders
A
Cequel::Record::Schema
A
Cequel::Metal::Logging
A
Cequel::Record::Scoped
A
Cequel::Metal::Row#ttl
A
Cequel::Type.register
A
Cequel::Metal::Row
A
Cequel::Uuids#uuid
A
Cequel::Type.[]
A
Cequel::Record
A
Cequel::Uuids
A
Cequel::Record::RecordGenerator#create_record
A
Cequel::Schema::TableProperty#value
A
Cequel::Metal::Keyspace#port
A
Cequel::Type::Base#cql_name
A
Cequel::Type::Base#to_s
A
Cequel::Type.quote
A
Cequel::Record::Schema::ClassMethods#reflect_on_column
A
Cequel::Schema::Table#clustering_column
A
Cequel::Schema::Table#partition_key
A
Cequel::Schema::Keyspace#read_table
A
Cequel::Schema::Table#data_column
A
Cequel::Schema::Table#property
A
Cequel::Schema::Table#column
A
Cequel::Metal::DataSet#each
A
Cequel::Metal::Keyspace#[]
A
Cequel::Record::Associations::ClassMethods#belongs_to
A
Cequel::Record::Associations::ClassMethods#has_many
A
Cequel::SpecSupport::Preparation#record_classes
A
Cequel::Record::Properties::ClassMethods#column
A
Cequel::Schema::TableUpdater#change_properties
A
Cequel::Record::Properties::ClassMethods#list
A
Cequel::Record::Persistence#update_attributes
A
Cequel::Record::Properties::ClassMethods#key
A
Cequel::Schema::UpdateTableDSL#change_column
A
Cequel::Record::Properties::ClassMethods#set
A
Cequel::Record::Associations::ClassMethods
A
Cequel::Record::AssociationCollection#find
A
Cequel::Record::AssociationCollection#each
A
Cequel::Schema::TableUpdater#change_column
A
Cequel::Record::RecordSet#find_in_batches
A
Cequel::Record::Properties::ClassMethods
A
Cequel::Schema::TableSynchronizer.apply
A
Cequel::Schema::CreateTableDSL#column
A
Cequel::Schema::Table#add_data_column
A
Cequel::Record::AssociationCollection
A
Cequel::Record::BelongsToAssociation
A
Cequel::Record::Persistence#destroy
A
Cequel::Metal::Updater#list_replace
A
Cequel::Record.establish_connection
A
Cequel::Record::RecordSet#find_each
A
Cequel::Metal::DataSet#list_prepend
A
Cequel::Metal::Updater#list_prepend
A
Cequel::Schema::CreateTableDSL#list
A
Cequel::Schema::CreateTableDSL#with
A
Cequel::Metal::Updater#list_append
A
Cequel::Metal::Updater#list_remove
A
Cequel::Metal::DataSet#list_remove
A
Cequel::Schema::CreateTableDSL#map
A
Cequel::Schema::CreateTableDSL#set
A
Cequel::Schema::CreateTableDSL#key
A
Cequel::Metal::DataSet#list_append
A
Cequel::Metal::DataSet#consistency
A
Cequel::Schema::Table#add_property
A
Cequel::Record::HasManyAssociation
A
Cequel::Metal::DataSet#set_remove
A
Cequel::Schema::Keyspace#keyspace
A
Cequel::Schema::TableSynchronizer
A
Cequel::Metal::DataSet#map_update
A
Cequel::Metal::Updater#map_update
A
Cequel::Metal::Updater#set_remove
A
Cequel::Record::Callbacks#destroy
A
Cequel::Schema::TableReader#table
A
Cequel::Record::RecordSet#reverse
A
Cequel::Metal::Keyspace#configure
A
Cequel::Schema::CollectionColumn
A
Cequel::Type::Base#internal_name
A
Cequel::Record::RecordSet#before
A
Cequel::Record::Persistence#save
A
Cequel::Record::RecordSet#after
A
Cequel::Record::RecordSet#limit
A
Cequel::Record::RecordSet#first
A
Cequel::Record::RecordSet#upto
A
Cequel::Record::RecordSet#last
A
Cequel::Record::Properties#[]=
A
Cequel::Record::Callbacks#save
A
Cequel::Schema::Table#add_list
A
Cequel::Metal::Updater#set_add
A
Cequel::Record::MassAssignment
A
Cequel::Record::RecordSet#from
A
Cequel::Schema::CreateTableDSL
A
Cequel::Metal::DataSet#set_add
A
Cequel::Schema::Table#add_set
A
Cequel::Schema::Table#add_key
A
Cequel::Metal::DataSet#insert
A
Cequel::Record::Properties#[]
A
Cequel::Schema::Table#add_map
A
Cequel::Metal::DataSet#order
A
Cequel::Type.lookup_internal
A
Cequel::Record::RecordSet#in
A
Cequel::Record::Validations
A
Cequel::Schema::MapProperty
A
Cequel::Metal::Incrementer
A
Cequel::Record::BulkWrites
A
Cequel::Record::Collection
A
Cequel::Metal::Updater#set
A
Cequel::Record::Properties
A
Cequel::Schema::Keyspace
A
Cequel::Metal::Inserter
A
Cequel::Type.lookup_cql
A
Cequel::Type::Timestamp
A
Cequel::Type::Timeuuid
A
Cequel::Metal::Updater
A
Cequel::Metal::Deleter
A
Cequel::Schema::Column
A
Cequel::Type::Counter
A
Cequel::Type::Decimal
A
Cequel::Record::Dirty
A
Cequel::Type::Boolean
A
Cequel::Type::String
A
Cequel::Type::Varint
A
Cequel::Type::Double
A
Cequel::Schema::List
A
Cequel::Record::List
A
Cequel::Type::Bigint
A
Cequel::Type::Ascii
A
Cequel::Schema::Map
A
Cequel::Record::Map
A
Cequel::Record::Set
A
Cequel::Schema::Set
A
Cequel::Type::Base
A
Cequel::Type::Text
A
Cequel::Type::Inet
A
Cequel::Type::Blob
A
Cequel::Type::Uuid
A
Cequel::Type::Int
A
Cequel.connect
A
Cequel::SpecSupport::Preparation#load_all_models
A
Cequel::Record::AssociationCollection#select
A
Cequel::Schema::MigrationValidator.validate!
A
Cequel::Record::AssociationCollection#first
A
Cequel::Type::Counter#compatible_types
A
Cequel::Type::Timestamp#internal_names
A
Cequel::Record::Collection#persisted!
A
Cequel::Type::Timeuuid#internal_names
A
Cequel::Type::Ascii#compatible_types
A
Cequel::Type::Counter#internal_names
A
Cequel::Record::RecordSet#delete_all
A
Cequel::Record::Persistence#exists?
A
Cequel::Type::Varint#internal_names
A
Cequel::Type::Bigint#internal_names
A
Cequel::Record::Collection#loaded!
A
Cequel::Type::Uuid#internal_names
A
Cequel::Type::Inet#internal_names
A
Cequel::Type::Blob#internal_names
A
Cequel::Type::Text#internal_names
A
Cequel::Type::Int#internal_names
A
Cequel::Type::Text#cql_aliases
A
Cequel::Record::Bound.create
Proper documentation present
B
Cequel::Schema::UpdateTableDSL#create_index
B
Cequel::Metal::Keyspace#sanitize
B
Cequel::Metal::Keyspace#write
B
Cequel::Metal::Keyspace#write_with_consistency
B
Cequel::Record::Collection#initialize
Show 20 more ...
B
Cequel::Schema::Column#initialize
B
Cequel::Type::Base#cast
B
Cequel::Record.included
B
Cequel::Schema::Map#cast
B
Cequel::Schema::Set#cast
B
Cequel::Schema::ClusteringColumn#initialize
B
Cequel::Schema::DataColumn#initialize
B
Cequel::Metal::Inserter#initialize
B
Cequel::Schema::Map#initialize
B
Cequel::Type::Timestamp#cast
B
Cequel::Type::Timeuuid#cast
B
Cequel::Type::Counter#cast
B
Cequel::Type::Boolean#cast
B
Cequel::Type::Decimal#cast
B
Cequel::Schema::List#cast
B
Cequel::Type::String#cast
B
Cequel::Type::Double#cast
B
Cequel::Type::Blob#cast
B
Cequel::Type::Uuid#cast
B
Cequel::Type::Int#cast
Needs work
C
Cequel::Schema::TableProperty#initialize
C
Cequel::Metal::DataSet#inspect
C
Cequel::Metal::DataSet#==
C
Cequel::Metal::Logging#slowlog=
C
Cequel::Record::Bound#initialize
Undocumented
U
Cequel:: #select_non_collection_columns!
U
Cequel::Record::Persistence#persisted!
U
Cequel::Record::Persistence#transient!
U
Cequel::Record::Schema::ClassMethods#map
U
Cequel:: #child_associations=
Show 76 more ...
U
Cequel:: #parent_association=
U
Cequel:: #create_configuration
U
Cequel::Record::RecordSet#find_nested_batches_from
U
Cequel::Record::LazyRecordCollection#connection
U
Cequel::SpecSupport::Preparation#initialize
U
Cequel::Record::LazyRecordCollection#table
U
Cequel::Record::RecordSet#traverse
U
Cequel::Schema::Map#value_type
U
Cequel:: #delegating_scope_key
U
Cequel::Record::Scoped::ClassMethods#delegating_scope=
U
Cequel::Record::Scoped::ClassMethods#delegating_scope
U
Cequel::Record::Schema::ClassMethods#compact_storage
U
Cequel::Record::RecordSet#resolve_if_fully_specified
U
Cequel::Record::Schema::ClassMethods#table_property
U
Cequel::Record::Timestamps::ClassMethods#timestamps
U
Cequel::Record::RecordSet#find_rows_in_single_batch
U
Cequel::Record::RecordSet#next_unscoped_key_column
U
Cequel::Record::RecordSet#without_upper_bound_on
U
Cequel::Record::RecordSet#next_unscoped_key_name
U
Cequel::Record::RecordSet#without_lower_bound_on
U
Cequel::Record::RecordSet#filter_secondary_index
U
Cequel::Schema::TableProperty#normalized_value=
U
Cequel::Record::RecordSet#scoped_indexed_column
U
Cequel::Record::RecordSet#next_range_key_column
U
Cequel::Record::RecordSet#unscoped_key_columns
U
Cequel::Record::RecordSet#next_range_key_name
U
Cequel::Record::RecordSet#scoped_key_columns
U
Cequel::Record::Timestamps::ClassMethods#key
U
Cequel::Record::RecordSet#filter_primary_key
U
Cequel::Record::RecordSet#unscoped_key_names
U
Cequel::Schema::TableUpdater#add_data_column
U
Cequel::SpecSupport::Preparation#model_dirs
U
Cequel::Record::RecordSet#query_consistency
U
Cequel::Record::RecordSet#scoped_key_values
U
Cequel::Record::Schema::ClassMethods#column
U
Cequel::Record::RecordSet#scoped_key_names
U
Cequel::Record::RecordSet#range_key_column
U
Cequel::Record::Properties#write_attribute
U
Cequel::Record::RecordSet#order_by_column
U
Cequel::Record::Properties#read_attribute
U
Cequel::Schema::TableSynchronizer#updater
U
Cequel::Record::Schema::ClassMethods#list
U
Cequel::Record::RecordSet#next_batch_from
U
Cequel::Metal::DataSet#query_consistency=
U
Cequel::Record::RecordSet#select_columns
U
Cequel::SpecSupport::Preparation#options
U
Cequel::Record::RecordSet#range_key_name
U
Cequel::Record::RecordSet#filter_columns
U
Cequel::Record::Schema::ClassMethods#set
U
Cequel::Record::Schema::ClassMethods#key
U
Cequel::Schema::TableUpdater#table_name
U
Cequel::Schema::TableUpdater#statements
U
Cequel::Metal::Logging#request_logger=
U
Cequel::Schema::TableReader#table_name
U
Cequel::Record::Collection#__setobj__
U
Cequel::Schema::Table#columns_by_name
U
Cequel::Record::RecordSet#upper_bound
U
Cequel::Record::RecordSet#lower_bound
U
Cequel::Metal::Logging#request_logger
U
Cequel::Schema::TableUpdater#keyspace
U
Cequel::Record::Collection#__getobj__
U
Cequel::Schema::TableWriter#keyspace
U
Cequel::Record::RecordSet#attributes
U
Cequel::Schema::TableReader#keyspace
U
Cequel::Record::Persistence#deleter
U
Cequel::Record::RecordSet#row_limit
U
Cequel::Record::Schema#table_schema
U
Cequel::Record::Persistence#updater
U
Cequel::Record::Persistence#update
U
Cequel::Record::Persistence#create
U
Cequel::Metal::DataSet#row_limit=
U
Cequel::Schema::TableWriter#table
U
Cequel::Schema::TableProperty.new
U
Cequel::Record::Callbacks#update
U
Cequel::Record::Callbacks#create
U
Cequel::Metal::Logging#log

Let's raise the visibility of documentation in Ruby!

This page is for cequel/cequel and is part of a project called "Inch Pages", showing documentation measurements provided by Inch. Inch Pages also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure!

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.

Fork me on GitHub