jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

split the API reference

Browse Source
This commit is contained in:
steve-chavez
2023-05-10 14:21:31 -03:00
committed by Steve Chavez
parent c82b23940b
commit fc635d18ae
16 changed files with 2954 additions and 2883 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/references/configuration.rst
+1 -24
View File
@@ -398,30 +398,7 @@ db-schemas
**In-Database** pgrst.db_schemas
=============== =================
The database schema to expose to REST clients. Tables, views and stored procedures in this schema will get API endpoints.
.. code:: bash
db-schemas = "api"
This schema gets added to the `search_path <https://www.postgresql.org/docs/current/ddl-schemas.html#DDL-SCHEMAS-PATH>`_ of every request.
List of schemas
~~~~~~~~~~~~~~~
You can also specify a list of schemas that can be used for **schema-based multitenancy** and **api versioning** by :ref:`multiple-schemas`. Example:
.. code:: bash
db-schemas = "tenant1, tenant2"
If you don't :ref:`Switch Schemas <multiple-schemas>`, the first schema in the list(``tenant1`` in this case) is chosen as the default schema.
*Only the chosen schema* gets added to the `search_path <https://www.postgresql.org/docs/current/ddl-schemas.html#DDL-SCHEMAS-PATH>`_ of every request.
.. warning::
Never expose private schemas in this way. See :ref:`schema_isolation`.
The list of database schemas to expose to clients. See :ref:`schemas`.
.. _db-tx-end: