community.missing_collection.rethinkdb_db_info_module.rst

community.missing_collection.rethinkdb_db_info

Get information about RethinkDB Database.

Version added: 0.2.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Get information about RethinkDB Database.
• https://rethinkdb.com/api/python/

Requirements

The below requirements are needed on the host that executes this module.

• rethinkdb

Parameters

Parameter	Choices/Defaults	Comments
database string		name of the database.
host string / required		hostname of rethinkdb.
list_database_config boolean	Choices: no yes	do you want to fetch database config?
list_databases boolean	Choices: no yes	do you want to fetch list of all databases?
list_tables boolean	Choices: no yes	do you want to fetch list tables from from database?
password string	Default: ""	password for rethinkdb user.
port integer	Default: 28015	port number of rethinkdb.
ssl dictionary	Default: "None"	use SSL for rethinkdb connection. may not work!.
user string	Default: "admin"	rethinkdb username.

Examples

- name: list all database in rethinkdb cluster
  community.missing_collection.rethinkdb_db_info:
    host: 'localhost'
    port: 28015
    user: 'admin'
    password: ''
    list_databases: true

- name: get information about given rethinkdb database
  community.missing_collection.rethinkdb_db_info:
    host: 'localhost'
    port: 28015
    user: 'admin'
    password: ''
    list_database_config: true
    database: 'database1'

- name: get list of tables of given rethinkdb database
  community.missing_collection.rethinkdb_db_info:
    host: 'localhost'
    port: 28015
    user: 'admin'
    password: ''
    list_tables: true
    database: 'database1'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
database_config dictionary	when success and defined list_database_config.	database configuration. Sample: {'id': '5eed5253-4267-4014-9434-50c78a8c0d0d', 'name': 'database1'}
databases list	when success and defined list_databases.	list of all the database rethinkdb cluster. Sample: ['database1', 'rethinkdb', 'test']
tables list	when success and defined tables.	list of all the tables rethinkdb database. Sample: ['table1', 'table2']

Status

Authors

• Davinder Pal (@116davinder) <dpsangwal@gmail.com>