# CassKeyspaceMeta

### struct CassKeyspaceMeta

Keyspace metadata 

### Public Functions

### void cass_keyspace_meta_name(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*\*name, size_t \*name_length)

Gets the name of the keyspace.

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **name** – **[out]** 
  * **name_length** – **[out]** 

### [cass_bool_t](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/group.BasicTypes.md#_CPPv411cass_bool_t) cass_keyspace_meta_is_virtual(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta)

Determine if the keyspace is a virtual keyspace.

* **Parameters:**
  **keyspace_meta** – **[in]** 
* **Returns:**
  cass_true is the keyspace is virtual, otherwise cass_false 

### const [CassTableMeta](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassTableMeta.md#_CPPv413CassTableMeta) \*cass_keyspace_meta_table_by_name(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*table)

Gets the table metadata for the provided table name.

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **table** – 
* **Returns:**
  The metadata for a table. NULL if table does not exist. 

### const [CassTableMeta](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassTableMeta.md#_CPPv413CassTableMeta) \*cass_keyspace_meta_table_by_name_n(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*table, size_t table_length)

Same as [cass_keyspace_meta_table_by_name()](#struct_cass_keyspace_meta_1a8d35dbbe718bea340a9887a5ca3d797b), but with lengths for string parameters.

#### SEE ALSO
[cass_keyspace_meta_table_by_name()](#struct_cass_keyspace_meta_1a8d35dbbe718bea340a9887a5ca3d797b)

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **table** – **[in]** 
  * **table_length** – **[in]** 
* **Returns:**
  same as [cass_keyspace_meta_table_by_name()](#struct_cass_keyspace_meta_1a8d35dbbe718bea340a9887a5ca3d797b)

### const [CassMaterializedViewMeta](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassMaterializedViewMeta.md#_CPPv424CassMaterializedViewMeta) \*cass_keyspace_meta_materialized_view_by_name(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*view)

Gets the materialized view metadata for the provided view name.

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **view** – 
* **Returns:**
  The metadata for a view. NULL if view does not exist. 

### const [CassMaterializedViewMeta](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassMaterializedViewMeta.md#_CPPv424CassMaterializedViewMeta) \*cass_keyspace_meta_materialized_view_by_name_n(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*view, size_t view_length)

Same as [cass_keyspace_meta_materialized_view_by_name()](#struct_cass_keyspace_meta_1a71ff3f74650f747a36884121484f1143), but with lengths for string parameters.

#### SEE ALSO
[cass_keyspace_meta_materialized_view_by_name()](#struct_cass_keyspace_meta_1a71ff3f74650f747a36884121484f1143)

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **view** – **[in]** 
  * **view_length** – **[in]** 
* **Returns:**
  same as [cass_keyspace_meta_materialized_view_by_name()](#struct_cass_keyspace_meta_1a71ff3f74650f747a36884121484f1143)

### const [CassDataType](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassDataType.md#_CPPv412CassDataType) \*cass_keyspace_meta_user_type_by_name(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*type)

Gets the data type for the provided type name.

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **type** – 
* **Returns:**
  The data type for a user defined type. NULL if type does not exist. 

### const [CassDataType](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassDataType.md#_CPPv412CassDataType) \*cass_keyspace_meta_user_type_by_name_n(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*type, size_t type_length)

Same as cass_keyspace_meta_type_by_name(), but with lengths for string parameters.

#### SEE ALSO
cass_keyspace_meta_type_by_name() 

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **type** – **[in]** 
  * **type_length** – **[in]** 
* **Returns:**
  same as cass_keyspace_meta_type_by_name()

### const [CassFunctionMeta](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassFunctionMeta.md#_CPPv416CassFunctionMeta) \*cass_keyspace_meta_function_by_name(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*name, const char \*arguments)

Gets the function metadata for the provided function name.

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **name** – **[in]** 
  * **arguments** – **[in]** A comma delimited list of CQL types (e.g “text,int,…”) describing the function’s signature.
* **Returns:**
  The data function for a user defined function. NULL if function does not exist. 

### const [CassFunctionMeta](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassFunctionMeta.md#_CPPv416CassFunctionMeta) \*cass_keyspace_meta_function_by_name_n(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*name, size_t name_length, const char \*arguments, size_t arguments_length)

Same as [cass_keyspace_meta_function_by_name()](#struct_cass_keyspace_meta_1aaea46b19981ae16339cf84d643d60274), but with lengths for string parameters.

#### SEE ALSO
[cass_keyspace_meta_function_by_name()](#struct_cass_keyspace_meta_1aaea46b19981ae16339cf84d643d60274)

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **name** – **[in]** 
  * **name_length** – **[in]** 
  * **arguments** – **[in]** 
  * **arguments_length** – **[in]** 
* **Returns:**
  same as [cass_keyspace_meta_function_by_name()](#struct_cass_keyspace_meta_1aaea46b19981ae16339cf84d643d60274)

### const [CassAggregateMeta](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassAggregateMeta.md#_CPPv417CassAggregateMeta) \*cass_keyspace_meta_aggregate_by_name(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*name, const char \*arguments)

Gets the aggregate metadata for the provided aggregate name.

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **name** – **[in]** 
  * **arguments** – **[in]** A comma delimited list of CQL types (e.g “text,int,…”) describing the aggregate’s signature.
* **Returns:**
  The data aggregate for a user defined aggregate. NULL if aggregate does not exist. 

### const [CassAggregateMeta](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassAggregateMeta.md#_CPPv417CassAggregateMeta) \*cass_keyspace_meta_aggregate_by_name_n(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*name, size_t name_length, const char \*arguments, size_t arguments_length)

Same as [cass_keyspace_meta_aggregate_by_name()](#struct_cass_keyspace_meta_1a5310a4dfcfbc168b5574dbc3dc7a485f), but with lengths for string parameters.

#### SEE ALSO
[cass_keyspace_meta_aggregate_by_name()](#struct_cass_keyspace_meta_1a5310a4dfcfbc168b5574dbc3dc7a485f)

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **name** – **[in]** 
  * **name_length** – **[in]** 
  * **arguments** – **[in]** 
  * **arguments_length** – **[in]** 
* **Returns:**
  same as [cass_keyspace_meta_aggregate_by_name()](#struct_cass_keyspace_meta_1a5310a4dfcfbc168b5574dbc3dc7a485f)

### [CassIterator](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassIterator.md#_CPPv412CassIterator) \*cass_iterator_tables_from_keyspace_meta(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta)

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over tables.

#### SEE ALSO
cass_iterator_get_table_meta() 

#### SEE ALSO
cass_iterator_free() 

* **Parameters:**
  **keyspace_meta** – **[in]** 
* **Returns:**
  A new iterator that must be freed.

### [CassIterator](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassIterator.md#_CPPv412CassIterator) \*cass_iterator_materialized_views_from_keyspace_meta(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta)

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over views.

#### SEE ALSO
cass_iterator_get_materialized_view_meta() 

#### SEE ALSO
cass_iterator_free() 

* **Parameters:**
  **keyspace_meta** – **[in]** 
* **Returns:**
  A new iterator that must be freed.

### [CassIterator](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassIterator.md#_CPPv412CassIterator) \*cass_iterator_user_types_from_keyspace_meta(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta)

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over types.

#### SEE ALSO
cass_iterator_get_user_type() 

#### SEE ALSO
cass_iterator_free() 

* **Parameters:**
  **keyspace_meta** – **[in]** 
* **Returns:**
  A new iterator that must be freed.

### [CassIterator](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassIterator.md#_CPPv412CassIterator) \*cass_iterator_functions_from_keyspace_meta(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta)

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over functions.

**Warning:** This function is not yet implemented.

#### SEE ALSO
cass_iterator_get_function_meta() 

#### SEE ALSO
cass_iterator_free() 

* **Parameters:**
  **keyspace_meta** – **[in]** 
* **Returns:**
  A new iterator that must be freed.

### [CassIterator](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassIterator.md#_CPPv412CassIterator) \*cass_iterator_aggregates_from_keyspace_meta(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta)

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over aggregates.

**Warning:** This function is not yet implemented.

#### SEE ALSO
cass_iterator_get_aggregate_meta() 

#### SEE ALSO
cass_iterator_free() 

* **Parameters:**
  **keyspace_meta** – **[in]** 
* **Returns:**
  A new iterator that must be freed.

### const [CassValue](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassValue.md#_CPPv49CassValue) \*cass_keyspace_meta_field_by_name(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*name)

Gets a metadata field for the provided name. Metadata fields allow direct access to the column data found in the underlying “keyspaces” metadata table.

**Warning:** This function is not yet implemented.

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **name** – **[in]** 
* **Returns:**
  A metadata field value. NULL if the field does not exist. 

### const [CassValue](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassValue.md#_CPPv49CassValue) \*cass_keyspace_meta_field_by_name_n(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta, const char \*name, size_t name_length)

Same as [cass_keyspace_meta_field_by_name()](#struct_cass_keyspace_meta_1a5569aef1ee38c0d0e4e592d2e50b4d7f), but with lengths for string parameters.

**Warning:** This function is not yet implemented.

#### SEE ALSO
[cass_keyspace_meta_field_by_name()](#struct_cass_keyspace_meta_1a5569aef1ee38c0d0e4e592d2e50b4d7f)

* **Parameters:**
  * **keyspace_meta** – **[in]** 
  * **name** – **[in]** 
  * **name_length** – **[in]** 
* **Returns:**
  same as [cass_keyspace_meta_field_by_name()](#struct_cass_keyspace_meta_1a5569aef1ee38c0d0e4e592d2e50b4d7f)

### [CassIterator](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/struct.CassIterator.md#_CPPv412CassIterator) \*cass_iterator_fields_from_keyspace_meta(const [CassKeyspaceMeta](#_CPPv416CassKeyspaceMeta) \*keyspace_meta)

Creates a new fields iterator for the specified keyspace metadata. Metadata fields allow direct access to the column data found in the underlying “keyspaces” metadata table. This can be used to iterate those metadata field entries.

**Warning:** This function is not yet implemented.

#### SEE ALSO
cass_iterator_get_meta_field_name() 

#### SEE ALSO
cass_iterator_get_meta_field_value() 

#### SEE ALSO
cass_iterator_free() 

* **Parameters:**
  **keyspace_meta** – **[in]** 
* **Returns:**
  A new iterator that must be freed.
