Files
TREK/server/assets/postgres/plugin-functions.txt
T
Maurice c970245e0d fix(plugins): hold plugin data on Postgres to its own schema and to one contract on both engines
The plugin SQL guard now refuses what still reached outside a plugin's
schema or depended on the server:
- reads of the system columns (xmin, xmax, cmin, cmax, ctid, tableoid),
  which show transaction ids and storage layout and do not exist on
  SQLite; a value of the plugin's own may still be named xmin with AS
- the xid and xid8 types wherever the word stands for the type, since
  age() of an xid is the cluster's transaction counter
- the text search functions that coerce a text argument to regconfig, a
  catalog lookup by name, which leave the allowlist
- collations and access methods outside the set every server has, which
  could tell whether a locale or an extension exists

Every plugin transaction pins, with SET LOCAL, the settings that decide
how values print and parse (TimeZone UTC, DateStyle, the C locales, float,
bytea and xml output, the text search configuration), so a plugin's output
neither depends on nor reveals the server's configuration.

Both stores now keep one contract. Its texts and caps live once, in
plugin-data-contract.ts, and both stores throw only those: NUL in SQL,
an argument or a migration id is refused on SQLite as on Postgres,
transaction control is refused in every call on both engines (tx() is
how a batch becomes atomic), a closed store refuses every call, and the
Postgres store answers the cases better-sqlite3 names with its words.
The SQLite store moves beside the Postgres one as SqlitePluginDataStore
in db/engine/sqlite, takes its file from the backend so src/db never
imports src/nest, and no longer needs the driver exemption. A contract
test runs every violation on both stores and fails when they answer
differently. The Postgres lane holds the allowlist, the pinned settings
and the SQL plugins commonly write against a real database.
2026-11-18 13:20:07 +01:00

424 lines
5.3 KiB
Plaintext

# The functions of Postgres's pg_catalog a plugin's own SQL may call, one name per line,
# grouped. Read by src/db/engine/postgres/plugin-sql-functions.ts; every name must be in
# catalog-functions.txt (a unit test checks). A line starting with # is a comment.
# Strings and bytes.
ascii
bit_count
bit_length
btrim
casefold
char_length
character_length
chr
concat
concat_ws
convert
convert_from
convert_to
crc32
crc32c
decode
encode
format
get_bit
get_byte
initcap
is_normalized
left
length
like
lower
lpad
ltrim
md5
normalize
octet_length
overlay
position
quote_ident
quote_literal
quote_nullable
regexp_count
regexp_instr
regexp_like
regexp_match
regexp_matches
regexp_replace
regexp_split_to_array
regexp_split_to_table
regexp_substr
repeat
replace
reverse
right
rpad
rtrim
set_bit
set_byte
sha224
sha256
sha384
sha512
split_part
starts_with
string_to_array
string_to_table
strpos
substr
substring
to_ascii
to_bin
to_hex
to_oct
translate
unistr
upper
# Numbers.
abs
acos
acosd
acosh
asin
asind
asinh
atan
atan2
atan2d
atand
atanh
cbrt
ceil
ceiling
cos
cosd
cosh
cot
cotd
degrees
div
erf
erfc
exp
factorial
floor
gamma
gcd
lcm
lgamma
ln
log
log10
min_scale
mod
pi
pow
power
radians
random
random_normal
round
scale
sign
sin
sind
sinh
sqrt
tan
tand
tanh
trim_scale
trunc
width_bucket
# Dates and times.
age
clock_timestamp
date_add
date_bin
date_part
date_subtract
date_trunc
extract
isfinite
justify_days
justify_hours
justify_interval
make_date
make_interval
make_time
make_timestamp
make_timestamptz
now
overlaps
statement_timestamp
timeofday
timezone
to_char
to_date
to_number
to_timestamp
transaction_timestamp
# Conversions, also the type names written with a modifier (`varchar(20)`, `numeric(10, 2)`).
bit
bool
bpchar
bytea
char
date
float4
float8
int2
int4
int8
interval
numeric
text
time
timestamp
timestamptz
timetz
varbit
varchar
# JSON.
array_to_json
json_agg
json_agg_strict
json_array_elements
json_array_elements_text
json_array_length
json_build_array
json_build_object
json_each
json_each_text
json_extract_path
json_extract_path_text
json_object
json_object_agg
json_object_agg_strict
json_object_agg_unique
json_object_agg_unique_strict
json_object_keys
json_populate_record
json_populate_recordset
json_strip_nulls
json_to_record
json_to_recordset
json_typeof
jsonb_agg
jsonb_agg_strict
jsonb_array_elements
jsonb_array_elements_text
jsonb_array_length
jsonb_build_array
jsonb_build_object
jsonb_each
jsonb_each_text
jsonb_extract_path
jsonb_extract_path_text
jsonb_insert
jsonb_object
jsonb_object_agg
jsonb_object_agg_strict
jsonb_object_agg_unique
jsonb_object_agg_unique_strict
jsonb_object_keys
jsonb_path_exists
jsonb_path_exists_tz
jsonb_path_match
jsonb_path_match_tz
jsonb_path_query
jsonb_path_query_array
jsonb_path_query_array_tz
jsonb_path_query_first
jsonb_path_query_first_tz
jsonb_path_query_tz
jsonb_populate_record
jsonb_populate_record_valid
jsonb_populate_recordset
jsonb_pretty
jsonb_set
jsonb_set_lax
jsonb_strip_nulls
jsonb_to_record
jsonb_to_recordset
jsonb_typeof
row_to_json
to_json
to_jsonb
# Arrays and sets.
array_append
array_cat
array_dims
array_fill
array_length
array_lower
array_ndims
array_position
array_positions
array_prepend
array_remove
array_replace
array_reverse
array_sample
array_shuffle
array_sort
array_to_string
array_upper
cardinality
generate_series
generate_subscripts
trim_array
unnest
num_nonnulls
num_nulls
# Aggregates.
any_value
array_agg
avg
bit_and
bit_or
bit_xor
bool_and
bool_or
corr
count
covar_pop
covar_samp
every
max
min
mode
percentile_cont
percentile_disc
range_agg
range_intersect_agg
regr_avgx
regr_avgy
regr_count
regr_intercept
regr_r2
regr_slope
regr_sxx
regr_sxy
regr_syy
stddev
stddev_pop
stddev_samp
string_agg
sum
var_pop
var_samp
variance
# Window functions.
cume_dist
dense_rank
first_value
lag
last_value
lead
nth_value
ntile
percent_rank
rank
row_number
# UUIDs.
gen_random_uuid
uuid_extract_timestamp
uuid_extract_version
uuidv4
uuidv7
# Ranges and the plugin's own enum types.
datemultirange
daterange
enum_first
enum_last
enum_range
int4multirange
int4range
int8multirange
int8range
isempty
lower_inc
lower_inf
multirange
nummultirange
numrange
range_merge
tsmultirange
tsrange
tstzmultirange
tstzrange
upper_inc
upper_inf
# Geometry.
area
bound_box
box
center
circle
diagonal
diameter
height
isclosed
isopen
line
lseg
npoints
path
pclose
point
polygon
popen
radius
slope
width
# Network addresses.
abbrev
broadcast
cidr
family
host
hostmask
inet_merge
inet_same_family
macaddr
macaddr8
masklen
netmask
network
set_masklen
# Full text search on vectors and queries a plugin builds itself (array_to_tsvector,
# 'a & b'::tsquery). The functions that parse text into them (to_tsvector, to_tsquery,
# plainto_tsquery, phraseto_tsquery, websearch_to_tsquery, json_to_tsvector,
# jsonb_to_tsvector, ts_headline) take a text search configuration, a regconfig looked up
# by a name in a string, so to_tsvector('schema.cfg', ...) tells whether a schema or a
# configuration exists; they stay refused, as do ts_stat and ts_rewrite, which run SQL
# handed to them as text. No function here may take or return a type that looks an object
# up by name (the Postgres lane checks every overload).
array_to_tsvector
numnode
querytree
setweight
strip
ts_delete
ts_filter
ts_rank
ts_rank_cd
tsvector_to_array
# The TABLESAMPLE methods (`TABLESAMPLE SYSTEM (10)`).
bernoulli
system