community.missing_collection.couchdb_db_module.rst

community.missing_collection.couchdb_db

Create/Delete Couchdb Database.

Version added: 0.2.0

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

Synopsis

• Create/Delete Couchdb Database.
• https://docs.couchdb.org/en/stable/api/index.html

Requirements

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

• requests

Parameters

Parameter	Choices/Defaults	Comments
database string / required		name of the database.
host string	Default: "localhost"	hostname/ip of couchdb.
partitioned boolean	Choices: no ← yes	do you want to create partitioned database?
password string	Default: "password"	password for couchdb user.
port string	Default: "5984"	port number of couchdb.
replicas integer	Default: 3	number of replicas for database.
scheme string	Choices: http ← https	http scheme for couchdb.
shards integer	Default: 8	number of shards for database.
state string	Choices: present ← absent	state of the database.
user string	Default: "admin"	couchdb username.

Examples

- name: create database in couchdb
  community.missing_collection.couchdb_db:
    scheme: 'http'
    host: 'localhost'
    port: '5984'
    user: 'admin'
    password: 'password'
    state: 'present'
    database: 'test1'

- name: delete database in couchdb
  community.missing_collection.couchdb_db:
    scheme: 'http'
    host: 'localhost'
    port: '5984'
    user: 'admin'
    password: 'password'
    state: 'absent'
    database: 'test1'

Return Values

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

Key	Returned	Description
result dictionary	when success.	result of the api request.

Status

Authors

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