warehouse::client::Client Class Reference
List of all members.
Detailed Description
The warehouse library interface.
Definition at line 199 of file client.py.
Member Function Documentation
| def warehouse::client::Client::__del__ |
( |
|
self |
) |
|
| def warehouse::client::Client::__init__ |
( |
|
self |
) |
|
Initialize the warehouse library
Definition at line 204 of file client.py.
| def warehouse::client::Client::drop_db |
( |
|
self, |
|
|
|
db_name | |
|
) |
| | |
Drop a database. This will invalidate all connections to the database
@param db_name : Name of the databse to delete
Definition at line 229 of file client.py.
| def warehouse::client::Client::has_collection |
( |
|
self, |
|
|
|
db_name, |
|
|
|
collection_name | |
|
) |
| | |
Checks for the existence of a collection in a database.
@param db_name : Name of a database
@param collection_name : Name of a collection
Definition at line 220 of file client.py.
| def warehouse::client::Client::setup_collection |
( |
|
self, |
|
|
|
db_name, |
|
|
|
collection_name, |
|
|
|
msg, |
|
|
|
indexed_fields | |
|
) |
| | |
Create a new collection in the specified database. The collection will contain documents of type <pkg_type>.<msg_type>
@param db_name : Name of the database
@param collection_name : Name of the collection
@param msg : Message type
@param indexed_fields: Fields on which to index the data. Each element must be a nested field specifier such as 'pose.position.x'
@return A instance of connection to the specified collection
Definition at line 253 of file client.py.
Member Data Documentation
The documentation for this class was generated from the following file:
