dbschema database connection authentication

PGRST_PRE_REQUEST ¶Ī schema-qualified stored procedure name to call right after switching roles for a client request. Limits payload size for accidental or malicious requests. PGRST_MAX_ROWS ¶Ī hard limit to the number of rows PostgREST+ will fetch from a view, table, or stored procedure. When this is set to true, the value derived from jwt-secret will be treated as a base64 encoded secret. If this claim is present in the client provided JWT then you must set this to the same value as in the JWT, otherwise verifying the JWT will fail. Both symmetric and asymmetric cryptography are supported.

Note that any binary secrets must be base64 encoded. This is useful for automating deployments. Choosing a value for this parameter beginning with the at sign such as loads the secret out of an external file. If this parameter is not specified then authentication requests will be refused. For security the key must be at least 32 characters long. The secret or JSON Web Key (JWK) (or set) used to decode JWT tokens clients provide for authentication. Use a complete URI syntax PGRST_JWT_SECRET ¶ Overrides the base URL used within the OpenAPI self-documentation hosted at the API root path. Server-unix-socket-mode = '660' PGRST_OPENAPI_SERVER_PROXY_URI ¶ *6 - any IPv4 or IPv6 hostname, IPv6 preferred.*4 - any IPv4 or IPv6 hostname, IPv4 preferred.In addition to the usual address options, PostgREST+ interprets these reserved addresses with special meanings: The name of the notification channel to listen to (default pgrst) for schema refresh messages.Įxecuting NOTIFY pgrst, '' will trigger a 'schema cache refresh' PGRST_DB_CHANNEL_ENABLED ¶Ī boolean flag (default true) to enable/disable listening on the notifications channel. Multiple schemas can be added in a comma-separated string, e.g. These schemas tables, views and stored procedures don't get API endpoints, they can only be referred from the database objects inside your db-schema. PGRST_DB_EXTRA_SEARCH_PATH ¶Įxtra schemas to add to the search_path of every request. Once a new request arrives a new connection will be started. If the timeout is reached the connection will be closed.

Time to live, in seconds, for an idle database pool connection. Having enough here for the maximum expected simultaneous client connections can improve performance. Number of connections to keep open in the database pool. The database role to use when executing commands on behalf of unauthenticated clients. Never expose private schemas in this way. Tables, views and stored procedures in this schema will get API endpoints. The database schema to expose to REST clients. Read requests ( GET) will be directed to one of the read replicas using a round-robin algorithm. PGRST_DB_READ_REPLICAS_URI ¶Ī list of connection strings, separated by. The standard connection PostgreSQL URI format. The nginx error (log level) PostgREST+ ¶ PGRST_DB_URI ¶ Use 0 as a value for production deployments ENABLE_CACHE ¶Ī flag to enable the caching subsystem (note that you still need to define a few lua functions to specify what and when to cache) RELAY_ID_COLUMN ¶ ERR_LOGLEVEL ¶ DEVELOPMENT ¶Ī flag to enable/disable some debugging information in logs and response headers when in development mode DB_HOST ¶ĭatabase user (in the docs it's referred to as authenticator user) DB_PASS ¶ The database schema to expose to REST (and GraphQL) clients.

Dbschema database connection authentication