Skip to content

Latest commit

 

History

History
230 lines (197 loc) · 7.74 KB

community.missing_collection.rethinkdb_db_module.rst

File metadata and controls

230 lines (197 loc) · 7.74 KB

community.missing_collection.rethinkdb_db

Create/Delete RethinkDB Database.

Version added: 0.2.0

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

  • rethinkdb
Parameter Choices/Defaults Comments
database
string / required
name of the database.
host
string / required
hostname of rethinkdb.
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!.
state
string
    Choices:
  • present ←
  • absent
state of database.
user
string
Default:
"admin"
rethinkdb username.

- name: create database in rethinkdb
  community.missing_collection.rethinkdb_db:
    host: "localhost"
    port: 28015
    user: 'admin'
    password: ''
    state: present
    database: "test1"

- name: delete database in rethinkdb
  community.missing_collection.rethinkdb_db:
    host: "localhost"
    port: 28015
    user: 'admin'
    password: ''
    state: absent
    database: "test1"

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

Key Returned Description
result
dictionary
when success for state `present/absent`.
result of create/delete database query.

Sample:
{'config_changes': [{'new_val': None, 'old_val': {'id': '415f922c-a2c0-43af-b7ba-5514b3ebf32c', 'name': 'test1'}}], 'dbs_dropped': 1, 'tables_dropped': 0}


Authors