Laurence Isla
fcf828fd92
docs: clarify usage of upsert with surrogate primary keys
2024-11-15 12:05:14 -05:00
Joel Jakobsson and GitHub
180a96ce48
remove support for Prefer: params=single-object ( #3757 )
...
BREAKING CHANGE
Using this preference was deprecated in 6c3d7a9 , in favor of Functions with an array of JSON objects.
2024-11-04 20:19:08 -05:00
steve-chavez
bee862c2fa
docs: inline one-to-one relationship SQL
...
More direct than having to jump to the sample film database definition.
2024-10-21 14:45:53 -05:00
Dan Kurin and Steve Chavez
5ca969f4b8
docs: add PGRST123 to error table
2024-10-17 19:21:07 -05:00
steve-chavez
28ebe37e07
docs: example for server-host
2024-10-07 17:14:43 -05:00
steve-chavez
7e99babec7
feat: log pool maximum size
...
It's important for observability to have an historic trace of the pool
size. Currently we expose it on the metrics endpoint, but not all
deployments use it.
This logs the pool size after the successful connection log to make it
more visible:
<timestamp>: Connection Pool initialized with a maximum size of 4 connections
2024-10-02 22:47:22 -05:00
steve-chavez
87dddd66d2
fix: clarify "listening" logs
...
It's not immediately clear on which port the API server is listening.
Also it's not clear that the "pgrst" channel is for database
notifications.
Goes from:
<timestamp>: Admin server listening on 0.0.0.0:3001
<timestamp>: Listening on 0.0.0.0:3000
<timestamp>: Listening for notifications on the "pgrst" channel
To:
<timestamp>: Admin server listening on 0.0.0.0:3001
<timestamp>: API server listening on 0.0.0.0:3000
<timestamp>: Listening for database notifications on the "pgrst" channel
2024-10-02 22:47:22 -05:00
Jason Close and steve-chavez
f21053dbee
docs: rpc example for array of json objects
...
This change adds an explanation of how to handle an array of JSON objects within an RPC call. To pass multiple objects, an array of JSON objects must be the JSON value, with the key being the json or jsonb variable name of the Postgres function.
For people who want to perform multiple tasks/inserts/updates within a single API call, this is a needed explanation for that use-case.
2024-08-23 13:01:43 -05:00
steve-chavez
cccf8b750d
docs: rename to hoisted function settings
2024-08-01 19:17:56 -05:00
Andrei Dziahel and GitHub
06cbc4be36
config forbid same server-port and admin-server-port ( #3559 )
...
* fix: forbid same server-port and admin-server-port
Forbids server-port and admin-server-port from being equal altogether,
despite they might not conflict at all in case admin and app are bound
to different addresses. Implemented as per the discussion at
https://github.com/PostgREST/postgrest/issues/3508#issuecomment-2125123633
2024-07-03 13:02:02 -05:00
Laurence Isla
b9004baa3f
docs: add missing "curl --get" on embedding example
2024-07-02 15:20:54 -05:00
Sandro Bauer and GitHub
2fd5a00269
docs: fix rendering for inline code block in operator list
2024-07-02 12:27:58 +02:00
steve-chavez
ecf9d56c91
docs: add listener recovery
2024-06-25 20:03:22 -05:00
Andrei Dziahel and GitHub
9d7e87b3e0
feat: add the "admin-server-host" config to set the host for the admin server
2024-06-24 14:47:19 -05:00
Wolfgang Walther
fd6cd037ec
docs: Fix linkcheck
...
Some URLs are still forbidden for our linkcheck tool, so disabling them
again.
Others are permanently redirected, so adjusting them.
2024-06-19 08:40:15 +02:00
Laurence Isla and Steve Chavez
15a97738fb
docs: fix example of listener failure on read replicas
2024-06-12 19:43:58 -05:00
Laurence Isla
b52937ef4a
docs: clarify what is logged when "log-level=debug"
2024-06-12 18:19:16 -05:00
Laurence Isla
3f9027904a
docs: add missing logs to stderr
...
- Schema cache stats are now logged to stderr
- Log when the LISTEN channel gets a notification
2024-06-12 18:19:16 -05:00
Laurence Isla and Steve Chavez
5afa321e89
docs: add "Listener" page
...
Co-authored-by: Steve Chavez <stevechavezast@gmail.com >
2024-06-12 18:19:16 -05:00
Laurence Isla
db85faf3ed
docs: wrap in double quotes the filters with reserved characters in logical operators
2024-06-05 17:59:44 -05:00
Laurence Isla
aaf2d2e430
docs: add example for double embedding when doing OR filtering across embeds
2024-06-04 16:51:28 -05:00
Laurence Isla
50b2d302d0
docs: use "curl --get" for better readability when necessary
2024-05-31 20:24:06 -05:00
steve-chavez
a51a74b3c1
docs: shorten CLI
2024-05-24 18:05:45 -05:00
steve-chavez
30ca64d849
docs: improve observability
2024-05-24 18:05:45 -05:00
Laurence Isla
f5767b8d86
docs: add "config" and "schema_cache" endpoints to the admin server
2024-05-22 19:16:01 -05:00
Taimoor Zaeem and Steve Chavez
8cbcf9867b
feat: add config db-hoisted-tx-settings to allow only hoisted function settings
2024-05-21 19:50:03 -05:00
Taimoor Zaeem and Steve Chavez
5cc32c7f87
fix: fix incorrect 413 error on pg 54* errors
2024-05-20 18:59:33 -05:00
steve-chavez
d25df459ea
feat: add metric label for scache load
...
localhost:3001/metrics now includes:
pgrst_schema_cache_loads_total{status="FAIL"} 352.0
pgrst_schema_cache_loads_total{status="SUCCESS"} 3.0
This allows testing the failure case on:
https://github.com/PostgREST/postgrest/issues/3424#issuecomment-2104904910
2024-05-14 17:57:21 -05:00
Wolfgang Walther
aef29d49ba
docs: Mark db_tx_end as db-configurable
2024-05-12 11:53:59 +02:00
Taimoor Zaeem and Wolfgang Walther
7a5079542c
docs: update docs for pg error 53400
2024-05-12 11:47:05 +02:00
steve-chavez
0060abeb01
feat: /live and /ready respond with 500 on failure
...
503 is still used by /ready to indicate a transient state
that can be recovered from.
2024-05-08 17:19:48 -05:00
steve-chavez
df9b373465
docs: better place for application_name
2024-05-06 11:12:45 -05:00
steve-chavez
7e91e5311d
fix: not adding application_name on all URIs
2024-05-06 11:12:45 -05:00
Taimoor Zaeem and Steve Chavez
7e5fd317e6
docs: add docs page for CLI
2024-04-29 12:51:54 -05:00
Laurence Isla
85a4e35a2d
docs: fix http status for PGRST121 error
2024-04-24 15:04:35 -05:00
steve-chavez
3eff4670f0
docs: metrics for schema cache and connection pool
2024-04-23 19:08:37 -05:00
steve-chavez
3e615bd0d9
feat: add log-level=debug
2024-04-22 21:36:29 -05:00
Taimoor Zaeem and Steve Chavez
88abf600c4
fix: fix wrong http status on pg error 42P17 infinite recursion
2024-04-22 13:40:07 -05:00
steve-chavez
4428253efe
docs: move health_check.rst to admin_server.rst
2024-04-10 15:51:08 -05:00
steve-chavez
3d55f77bae
Revert "fix: slow responses on schema cache reload"
...
This reverts commit 727ef465c1 .
Also documents requests waiting for the schema cache.
2024-04-02 23:15:09 -05:00
steve-chavez
d7c64a93f8
docs: update schema cache
2024-04-01 19:03:14 -05:00
steve-chavez
9405a62de8
docs: update links to cache/config notify reload
2024-03-08 10:31:55 -05:00
Steve Chavez and GitHub
2f91853cb1
docs: add index usage section ( #3299 )
2024-03-02 11:00:31 -05:00
Wolfgang Walther and Wolfgang Walther
b8f35d880f
docs: Fix broken redirects in api.rst
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
791b86cbf6
docs: Add note about not support Stored Procedures
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/147
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
944b02fbb8
docs: Rename Stored Procedures to Functions consistently
...
This avoids confusing our RPCs with actual CREATE PROCEDURE, which we don't
support.
References https://github.com/PostgREST/postgrest-docs/issues/147
2024-02-21 09:40:11 +01:00
Laurence Isla and GitHub
229bc77886
docs: using or across embedded resources
2024-02-20 17:15:42 -05:00
Wolfgang Walther and Wolfgang Walther
fcd29caecf
docs: Use code-block postgres consistently
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
8f2b6b1652
docs: Add hint about schema reloading with db-config=true
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/490
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
b1deb049c8
docs: Clarify behavior of jwt-aud and tokens without aud claim
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/479
2024-02-19 21:54:15 +01:00