Taimoor ZaeemandSteve Chavez
a9a1763328
The `--ready` flag is a wrapper around the admin server `/ready` request. This is done through using an http client library in postgrest. Signed-off-by: Taimoor Zaeem <taimoorzaeem@gmail.com>
90 lines
1.9 KiB
ReStructuredText
90 lines
1.9 KiB
ReStructuredText
.. _cli:
|
|
|
|
CLI
|
|
===
|
|
|
|
PostgREST provides a CLI with the options listed below:
|
|
|
|
.. code:: text
|
|
|
|
Usage: postgrest [-v|--version] [-e|--example] [--dump-config | --dump-schema | --ready]
|
|
[FILENAME]
|
|
|
|
PostgREST / create a REST API to an existing Postgres
|
|
database
|
|
|
|
Available options:
|
|
-h,--help Show this help text
|
|
-v,--version Show the version information
|
|
-e,--example Show an example configuration file
|
|
--dump-config Dump loaded configuration and exit
|
|
--dump-schema Dump loaded schema as JSON and exit (for debugging,
|
|
output structure is unstable)
|
|
--ready Checks the health of PostgREST by doing a request on
|
|
the admin server /ready endpoint
|
|
FILENAME Path to configuration file
|
|
|
|
FILENAME
|
|
--------
|
|
|
|
Runs PostgREST with the given :ref:`file_config`.
|
|
|
|
Help
|
|
----
|
|
|
|
.. code:: bash
|
|
|
|
$ postgrest --help
|
|
|
|
Shows all the options available.
|
|
|
|
Version
|
|
-------
|
|
|
|
.. code:: bash
|
|
|
|
$ postgrest --version
|
|
|
|
Prints the PostgREST version.
|
|
|
|
Example
|
|
-------
|
|
|
|
.. code:: bash
|
|
|
|
$ postgrest --example
|
|
|
|
Shows example configuration settings.
|
|
|
|
Dump Config
|
|
-----------
|
|
|
|
.. code:: bash
|
|
|
|
$ postgrest --dump-config
|
|
|
|
Dumps the loaded :ref:`configuration` values, considering the configuration file, environment variables and :ref:`in_db_config`.
|
|
|
|
Dump Schema
|
|
-----------
|
|
|
|
.. code:: bash
|
|
|
|
$ postgrest --dump-schema
|
|
|
|
Dumps the schema cache in JSON format.
|
|
|
|
Ready Flag
|
|
----------
|
|
|
|
Makes a request to the ``/ready`` endpoint of the :ref:`admin_server`. It exits with a return code of ``0`` on success and ``1`` on failure.
|
|
|
|
.. code-block:: bash
|
|
|
|
$ postgrest --ready
|
|
OK: http://localhost:3001/ready
|
|
|
|
.. note::
|
|
|
|
The ``--ready`` flag cannot be used when :ref:`server-host` is configured with special hostnames. We suggest to change it to ``localhost``.
|