steve-chavez
e44178445d
docs: timezone offsets
2026-08-04 13:41:40 -05:00
steve-chavez
932c4f6328
perf: no caching for prefer timezone
...
`Prefer: timezone` no longer requires the schema cache.
Previously this required caching `pg_timezone_names` which was slow in some systems.
Closes https://github.com/PostgREST/postgrest/issues/5100 and
https://github.com/PostgREST/postgrest/issues/4751 .
2026-08-04 13:41:40 -05:00
steve-chavez
a41396c425
Revert "add: config db-timezone-enabled for optional querying of timezones"
...
This reverts commit d6c338d588 .
2026-08-04 13:41:40 -05:00
steve-chavez
ca4a6d9e99
Revert "add: configs as json GUC for db-root-spec"
...
This reverts commit f34ca15e84 .
2026-08-04 00:50:18 -05:00
steve-chavez
f34ca15e84
add: configs as json GUC for db-root-spec
...
These are needed for a complete OpenAPI spec
2026-08-03 23:41:03 -05:00
Taimoor Zaeem and Steve Chavez
669fc9ede8
docs: restructure PostGIS page
...
Restructure PostGIS page with order:
- `Accept: application/geo+json` request example
- Generated column example
- String representation example
Signed-off-by: Taimoor Zaeem <taimoorzaeem@gmail.com >
2026-06-01 12:59:15 -05:00
steve-chavez
b610b1ea51
docs: clarify set operators need views/functions
...
Closes https://github.com/PostgREST/postgrest/issues/4780 .
2026-04-03 17:02:21 -05:00
Taimoor Zaeem and Steve Chavez
d6c338d588
add: config db-timezone-enabled for optional querying of timezones
...
To avoid repeated querying of `pg_timezone_names` every time schema
cache is reset, `Prefer: timezone` can be disabled by setting
`db-timezone-enabled = false`.
Signed-off-by: Taimoor Zaeem <taimoorzaeem@gmail.com >
2026-04-01 12:48:38 -05:00
Andrei Dziahel and Steve Chavez
1f54e2accc
add: add "Vary" header to responses
...
Co-authored-by: Steve Chavez <stevechavezast@gmail.com >
2026-03-16 09:55:20 -05:00
Taimoor Zaeem and Steve Chavez
d75b1a7e96
docs: using default parameters on RPC with GET request
...
Signed-off-by: Taimoor Zaeem <taimoorzaeem@gmail.com >
2026-01-26 08:06:48 -05:00
Kian-Meng Ang and Steve Chavez
f5c7cde9b7
docs: fix typos
...
Found via `codespell -S test -L notin,nam,plantext,cryto,corelation,inout,ot`
2026-01-06 05:24:51 +08:00
Taimoor Zaeem and Steve Chavez
abad47ff1b
add: log error when db-schemas config contain restricted schemas
...
We don't allow accessing schemas "pg_catalog" and "information_schema".
Instead of silently failing requests on these schemas, this now adds
logging an error on startup when these schemas are found in `db-schemas`
config.
Signed-off-by: Taimoor Zaeem <taimoorzaeem@gmail.com >
2025-12-11 14:28:08 -05:00
Taimoor Zaeem and Steve Chavez
d905592115
docs: add asterisk character to reserved characters list
...
The `*` character is a reserved character in the postgrest
url grammar but we didn't mention it in the docs. Now added.
Signed-off-by: Taimoor Zaeem <taimoorzaeem@gmail.com >
2025-11-20 16:20:28 -05:00
Taimoor Zaeem and Steve Chavez
4b8dec8901
docs: clarify postgrest reserved characters in url grammar
...
Fixes a typo in the documentation where it said that `()`
is a reserved character, when we actually meant to say that
`(` and `)` are reserved characters.
Related discussion in #4254 .
Signed-off-by: Taimoor Zaeem <taimoorzaeem@gmail.com >
2025-11-20 16:20:28 -05:00
Steve Chavez and GitHub
bcf3457c28
docs: note index on automatic tsvector ( #4344 )
2025-09-19 13:49:30 -05:00
steve-chavez
f01d5bfeb3
docs: reorder computed relationships for clarity
...
Ensure the function inlining is mentioned first
2025-08-19 12:24:47 -05:00
Wolfgang Walther
55eafdf352
chore(deps): update nixpkgs to 25.05
2025-07-11 15:53:06 +00:00
Taimoor Zaeem and Steve Chavez
4daa4533d3
docs: horizontal filtering on table-valued functions
2025-07-02 14:28:49 -05:00
Taimoor Zaeem and Steve Chavez
dc46aea15e
fix: max-affected preference not failing for rpc with strict handling
2025-06-03 14:31:17 -05:00
Wolfgang Walther
07d9747c40
docs: fix functions link in api/preferences
...
External link syntax was used instead of internal reference.
2025-05-28 09:09:13 +02:00
Taimoor Zaeem and Steve Chavez
94d6ac2f2e
docs: explain use of max-affected preference with rpc
2025-05-22 12:23:52 -05:00
steve-chavez
520631913f
docs: add warning for duplicate keys in spread
2025-05-15 17:42:13 -05:00
steve-chavez
a659b0005a
docs: clarify spread join table
2025-05-15 15:50:54 -05:00
steve-chavez
23f11e3abb
docs: clarify fts
2025-05-15 11:57:08 -05:00
steve-chavez
211e27a4d7
docs: clarify spread feature
2025-05-15 11:14:06 -05:00
Taimoor Zaeem and GitHub
61a3c7b9e8
docs: add note that ordering of columns is not enforced ( #3999 )
2025-04-09 16:40:52 -05:00
steve-chavez
d89e7a2173
docs: redirect from broken #bulk-insert-default
2025-04-02 13:05:12 -05:00
Taimoor Zaeem and Steve Chavez
c7da7fab3a
docs: mention that updates also supports specifying columns and missing pref
2025-04-02 12:59:18 -05:00
Taimoor Zaeem and Steve Chavez
ddd7d98652
docs: explain missing preference header
2025-04-02 12:59:18 -05:00
Laurence Isla and GitHub
0b618d0bef
feat: allow spreading one-to-many and many-to-many embedded resources
...
* Note: Aggregates are not implemented
2025-03-24 14:45:56 +00:00
Laurence Isla
7be5782179
docs: make the aggregate functions docs less verbose
2025-02-14 18:14:43 -05:00
steve-chavez
33b69b5894
docs: reduce verbosity of aggregate functions
2025-02-12 20:12:38 -05:00
Steve Chavez and GitHub
307692c325
break: remove limited updated/delete feature ( #3907 )
...
BREAKING CHANGE
As agreed on https://github.com/PostgREST/postgrest/issues/3013#issuecomment-1770186262 ,
this removes the limited update/delete feature.
The feature was complicated, largely unused and caused other bugs in
mutations.
It was added in #2195 and #2211 .
2025-02-12 14:48:08 -05:00
Laurence Isla
b7d0a1f68c
feat: apply to_tsvector() explicitly to the full-text search filtered column, only if it's not of tsvector type
2025-01-28 19:14:54 -05:00
M. Taimoor Zaeem and Steve Chavez
a9d74eba2a
feat: allow not_null value for the is operator
2024-12-19 10:19:41 -05:00
kjcsb1 and GitHub
3e1a904785
docs: Add example of comment on view
2024-12-12 20:54:12 +01:00
Steve Chavez and GitHub
6db245aacd
fix: clarify PGRST116 error message ( #3795 )
...
Currently it's redundant and not easy to read.
```
{"message":"JSON object requested, multiple (or no) rows returned",
"details":"The result contains 2 rows"}
```
Now:
```
{"message":"Cannot coerce the result to a single JSON object",
"details":"The result contains an array of 0 objects"}
``
Also correct docs which had a wrong error code.
2024-11-20 12:15:46 -05:00
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
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
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
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
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 and GitHub
2f91853cb1
docs: add index usage section ( #3299 )
2024-03-02 11:00:31 -05: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