Dear Wiki user, You have subscribed to a wiki page or wiki category on "Cassandra Wiki" for change notification.
The "API" page has been changed by gdusbabek. The comment on this change is: Documented the system_* calls and structures.. http://wiki.apache.org/cassandra/API?action=diff&rev1=57&rev2=58 -------------------------------------------------- + + === CFDef, KSDef === + '''''Requires Cassandra 0.7''''' + + These structures contain fields necessary to describe keyspace and column family definitions. + + ==== CFDef ==== + ||'''Attribute''' ||'''Type''' ||'''Default''' ||'''Required''' ||'''Description''' || + ||`table`||`string`||None||Yes||Keyspace this CFDef belongs to|| + ||`name`||`string`||None||Yes||Name of column family. Must be unique to the keyspace|| + ||`column_type`||`string`||"Standard"||No||One of "Standard" or "Super"|| + ||`comparator_type`||`string`||"BytesType"||No||Name of comparator used for column sorting|| + ||`subcomparator_type`||`string`||None||No||Name of comparator used for subcolumns (when column_type="Super" only)|| + ||`comment`||`string`||None||No||Human-readable description of column family|| + ||`row_cache_size`||`double`||0||No||number of rows to cache|| + ||`preload_row_cache`||`boolean`||0 (False)||No||Set to true to automatically load the row cache|| + ||`key_cache_size`||`double`||200000||No||Number of keys to cache|| + + ==== KSDef ==== + ||'''Attribute''' ||'''Type''' ||'''Default''' ||'''Required''' ||'''Description''' || + ||`name`||`string`||None||Yes||Name of keyspace|| + ||`strategy_class`||`string`||None||Yes||Fully qualified class name of replication strategy|| + ||`replication_factor`||`integer`||None||Yes||Number of data replicas|| + ||`cf_defs`||`list<CfDef>`||None||Yes||list of column family definitions. Can be empty, but not null|| + + + + == Method calls == === login === ''Requires Cassandra 0.6'' @@ -317, +345 @@ Gets information about the specified keyspace. + === system_add_column_family === + ''Requires Cassandra 0.7'' + + . `string system_add_column_family(cf_def)` + + Adds a column family. This method will throw an exception if a column family with the same name is already associated with the keyspace. Returns the new schema version ID. + + === system_drop_column_family === + ''Requires Cassandra 0.7'' + + . `string system_drop_column_family(keyspace, column_family)` + + Drops a column family. Creates a snapshot and then submits a 'graveyard' compaction during which the abandoned files will be deleted. Returns the new schema version ID. + + === system_rename_column_family === + ''Requires Cassandra 0.7'' + + . `string system_rename_column_family(keyspace, old_name, new_name)` + + Renames a column family if the new name doesn't collide with an existing column family associated with the same keyspace. This operation blocks while the operating system renames files on disk. Returns the new schema version ID. + + === system_add_keyspace === + ''Requires Cassandra 0.7'' + + . `string system_add_keyspace(ks_def)` + + Creates a new keyspace and any column families defined with it. Callers '''are not required''' to first create an empty keyspace and then create column families for it. Returns the new schema version ID. + + === system_drop_keyspace === + ''Requires Cassandra 0.7'' + + . `string system_drop_keyspace(keyspace)` + + Drops a keyspace. Creates a snapshot and then submits a 'graveyard' compaction during which the abandoned files will be deleted. Returns the new schema version ID. + + === system_rename_keyspace === + ''Requires Cassandra 0.7'' + + . `string system_rename_keyspace(old_name, new_name)` + + Renames a keyspace if the new name doesn't collide with an existing keyspace. This operation blocks while the operating system renames files on disk. Returns the new schema version ID. + == Examples == [[http://wiki.apache.org/cassandra/ClientExamples|There are a few examples on this page over here.]]
