Source: lib/hypertable/comments.jsdoc


/**
 * AccessGroupOptions
 * @name AccessGroupOptions
 * @class
 * @param args {Object}
 * @param [args.replication] {Number} Replication factor
 * @param [args.blocksize] {Number} Block size
 * @param [args.compressor] {String} Compressor specification
 * @param [args.bloom_filter] {String} Bloom filter specification
 * @param [args.in_memory=false] {Boolean} In memory flag
 * @memberof module:hypertable
 */

/**
 * AccessGroupSpec
 * @name AccessGroupSpec
 * @class
 * @param args {Object}
 * @param args.name {String} Access group name
 * @param [args.generation] {Int64} Specification generation number
 * @param [args.options] {module:hypertable.AccessGroupOptions} Access group options
 * @param [args.defaults] {module:hypertable.ColumnFamilyOptions} Default column family options
 * @memberof module:hypertable
 */

/**
 * Cell
 * @name Cell
 * @class
 * @param args {Object}
 * @param args.key {module:hypertable.Key} Key
 * @param [args.value] {Buffer} Value
 * @memberof module:hypertable
 */

/**
 * CellInterval
 * @name CellInterval
 * @class
 * @param args {Object}
 * @param [args.start_row] {String} Starting row key
 * @param [args.start_column] {String} Starting column
 * @param [args.start_inclusive] {Boolean} Starting row/column is inclusive
 * @param [args.end_row] {String} Ending row key
 * @param [args.end_column] {String} Ending column
 * @param [args.end_inclusive] {Boolean} Ending row/column is inclusive
 * @memberof module:hypertable
 */

/**
 * ColumnFamilyOptions
 * @name ColumnFamilyOptions
 * @class
 * @param args
 * @param [args.max_versions] {Number} Max cell versions to keep
 * @param [args.ttl] {Number} Time-to-live value for cell versions
 * @param [args.time_order_desc] {Boolean} Cell version time order descending
 * @param [args.counter] {Boolean} Column family is counter
 * @memberof module:hypertable
 */

/**
 * ColumnFamilySpec
 * @name ColumnFamilySpec
 * @class
 * @param args {Object}
 * @param args.name {String} Column family name
 * @param args.access_group {String} Access group to which column family belongs
 * @param [args.deleted] {Boolean} Flag indicating if column family is deleted
 * @param [args.generation] {Int64} Specification generation number
 * @param [args.id] {Number} Column family ID
 * @param [args.value_index] {Boolean} Flag indicating if column family has a value index
 * @param [args.qualifier_index] {Boolean} Flag indicating if column family has a qualifier index
 * @param [args.options] {module:hypertable.ColumnFamilyOptions} Column family options
 * @memberof module:hypertable
 */

/**
 * Key
 * @name Key
 * @class
 * @param args {Object}
 * @param args.row {String} Row key
 * @param [args.column_family] {String} Column family
 * @param [args.column_qualifier] {String} Column qualifier
 * @param [args.timestamp] {Int64} Timestamp
 * @param [args.revision] {Int64} Revision
 * @param [args.flag=255] {Number} Cell flag
 * @memberof module:hypertable
 */

/**
 * RowInterval
 * @name RowInterval
 * @class
 * @param args {Object}
 * @param [args.start_row] {String} Starting row key
 * @param [args.start_inclusive] {Boolean} Starting row/column is inclusive
 * @param [args.end_row] {String} Ending row key
 * @param [args.end_inclusive] {Boolean} Ending row/column is inclusive
 * @memberof module:hypertable
 */

/**
 * Schema
 * @name Schema
 * @class
 * @param args {Object}
 * @param [args.access_groups] {Object} Access group map (name -> {@link module:hypertable.AccessGroupSpec AccessGroupSpec})
 * @param [args.column_families] {Object} Column family map (name -> {@link module:hypertable.ColumnFamilySpec ColumnFamilySpec})
 * @param [args.generation] {Int64} Specification generation number
 * @param [args.version] {Number} Schema version number
 * @param [args.group_commit_interval] {Number} Group commit interval (milliseconds)
 * @param [args.access_group_defaults] {module:hypertable.AccessGroupOptions} Default access group options
 * @param [args.column_family_defaults] {module:hypertable.ColumnFamilyOptions} Default column family options
 * @memberof module:hypertable
 */