Fix #191, Add db-extra-search-path config

This commit is contained in:
steve-chavez
2019-01-06 20:58:07 -05:00
committed by Steve Chávez
parent 93c3c59134
commit 702e055d43
+13 -3
View File
@@ -68,13 +68,14 @@ The user specified in the db-uri is also known as the authenticator role. For mo
Here is the full list of configuration parameters. Here is the full list of configuration parameters.
================ ====== ========= ======== ==================== ====== ========= ========
Name Type Default Required Name Type Default Required
================ ====== ========= ======== ==================== ====== ========= ========
db-uri String Y db-uri String Y
db-schema String Y db-schema String Y
db-anon-role String Y db-anon-role String Y
db-pool Int 10 db-pool Int 10
db-extra-search-path String public
server-host String 127.0.0.1 server-host String 127.0.0.1
server-port Int 3000 server-port Int 3000
server-proxy-uri String server-proxy-uri String
@@ -85,7 +86,7 @@ max-rows Int ∞
pre-request String pre-request String
app.settings.* String app.settings.* String
role-claim-key String .role role-claim-key String .role
================ ====== ========= ======== ==================== ====== ========= ========
.. _db-uri: .. _db-uri:
@@ -107,6 +108,8 @@ db-schema
The database schema to expose to REST clients. Tables, views and stored procedures in this schema will get API endpoints. The database schema to expose to REST clients. Tables, views and stored procedures in this schema will get API endpoints.
This schema gets added to the `search_path <https://www.postgresql.org/docs/11/ddl-schemas.html#DDL-SCHEMAS-PATH>`_ of every request.
.. _db-anon-role: .. _db-anon-role:
db-anon-role db-anon-role
@@ -121,6 +124,13 @@ db-pool
Number of connections to keep open in PostgREST's database pool. Having enough here for the maximum expected simultaneous client connections can improve performance. Note it's pointless to set this higher than the :code:`max_connections` GUC in your database. Number of connections to keep open in PostgREST's database pool. Having enough here for the maximum expected simultaneous client connections can improve performance. Note it's pointless to set this higher than the :code:`max_connections` GUC in your database.
db-extra-search-path
--------------------
Extra schemas to add to the `search_path <https://www.postgresql.org/docs/11/ddl-schemas.html#DDL-SCHEMAS-PATH>`_ of every request.
Multiple schemas can be added in a comma-separated string, e.g. ``public, extensions``.
.. _server-host: .. _server-host:
server-host server-host