summaryrefslogtreecommitdiff
path: root/doc/source/user/index.rst
blob: 6eabb98a1d1ca8b472db70b63bd798d1bb2b8aab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
=========================
 Trove Client User Guide
=========================

Command-line Interface
----------------------

Installing this package allows you to use ``openstack`` command to interact
with Trove. Refer to
https://docs.openstack.org/python-openstackclient/latest
for how to install ``openstack`` command and configuration.

You can find all supported Trove commands in ``openstack.database.v1``
entry_points section in ``setup.cfg`` file of the repo.

Python API
----------

There's also a complete Python API.

Quick-start using keystone::

    >>> from troveclient import client
    >>> trove_client = client.Client('1.0', session=keystone_session, endpoint_type='public', service_type='database', region_name='RegionOne')
    >>> trove_client.datastores.list()
    [...]
    >>> trove_client.instances.list()
    [...]

.. toctree::
   :maxdepth: 2

   api