trove/api-ref/source/databases.inc
Amrith Kumar d797074053 Update api-ref documentation
This change updates the api-ref documentation with some issues
identified in an earlier review.

Change-Id: Ic769a1ae376e8569f5a13af8feada88f4cf0ac32
Closes-Bug: 1614923
Related: I3315261aa18729fa7a6aa79d4a1d6c24de1e2c6b
2016-09-09 20:05:23 +00:00

136 lines
1.8 KiB
ReStructuredText

.. -*- rst -*-
=====================
Databases (databases)
=====================
Creates, lists all, and deletes databases.
Delete database
===============
.. rest_method:: DELETE /v1.0/{accountId}/instances/{instanceId}/databases/{databaseName}
Deletes a database.
This operation also deletes all data that is associated with the
database.
Error response codes:202,413,405,404,403,401,400,422,503,500,501,
Request
-------
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- databaseName: databaseName
- accountId: accountId
Create database
===============
.. rest_method:: POST /v1.0/{accountId}/instances/{instanceId}/databases
Creates a database within an instance.
Error response codes:202,413,405,404,403,401,400,422,503,500,501,
Request
-------
.. rest_parameters:: parameters.yaml
- characterSet: characterSet
- collate: collate
- name: name
- instanceId: instanceId
- accountId: accountId
Request Example
---------------
.. literalinclude:: samples/db-create-databases-request.json
:language: javascript
List instance databases
=======================
.. rest_method:: GET /v1.0/{accountId}/instances/{instanceId}/databases
Lists databases for an instance.
This operation returns only the user-defined databases and not the
system databases. Only the database administrator can view the
``mysql``, ``information_schema``, and ``lost+found`` system
databases.
Normal response codes: 200
Error response codes:413,405,404,403,401,400,422,503,500,501,
Request
-------
.. rest_parameters:: parameters.yaml
- instanceId: instanceId
- accountId: accountId
Response Example
----------------
.. literalinclude:: samples/db-list-databases-response.json
:language: javascript