Skip to content

Commit c521b9b

Browse files
committed
chore: improve pg config constraint comment
1 parent e2d5916 commit c521b9b

File tree

5 files changed

+20
-30
lines changed

5 files changed

+20
-30
lines changed

addons/postgresql/config/pg12-config-constraint.cue

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -550,8 +550,7 @@
550550
// Encrypt passwords.
551551
password_encryption?: string & "md5" | "scram-sha-256"
552552

553-
// Specifies which classes of statements will be logged by session audit logging.
554-
// "pgaudit.log"?: string & "ddl" | "function" | "misc" | "read" | "role" | "write" | "none" | "all" | "-ddl" | "-function" | "-misc" | "-read" | "-role" | "-write"
553+
// Specifies which classes of statements will be logged by session audit logging. Multiple classes can be provided using a comma-separated list and classes can be subtracted by prefacing the class with a - sign. Supported classes are: ddl, function, misc, read, role, write, none, all, -ddl, -function, -misc, -read, -role, -write.
555554
"pgaudit.log"?: string
556555

557556
// Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog.
@@ -833,17 +832,16 @@
833832
// Sets the planners estimate of the cost of a sequentially fetched disk page.
834833
seq_page_cost?: float & >=0
835834

836-
// Lists shared libraries to preload into each backend.
837-
session_preload_libraries?: string & "auto_explain" | "orafce" | "pg_bigm" | "pg_hint_plan" | "pg_prewarm" | "pg_similarity" | "pg_stat_statements" | "pg_transport" | "plprofiler"
835+
// Lists shared libraries to preload into each backend. Multiple libraries can be provided using a comma-separated list, e.g. 'pg_stat_statements, auto_explain'.
836+
session_preload_libraries?: string
838837

839838
// Sets the sessions behavior for triggers and rewrite rules.
840839
session_replication_role?: string & "origin" | "replica" | "local"
841840

842841
// (8kB) Sets the number of shared memory buffers used by the server.
843842
shared_buffers?: int & >=16 & <=1073741823 @storeResource(8KB)
844843

845-
// Lists shared libraries to preload into server.
846-
// TODO: support enum list, e.g. shared_preload_libraries = 'pg_stat_statements, auto_explain'
844+
// Lists shared libraries to preload into server. Multiple libraries can be provided using a comma-separated list, e.g. 'pg_stat_statements, auto_explain'.
847845
shared_preload_libraries?: string
848846

849847
// Enables SSL connections.

addons/postgresql/config/pg14-config-constraint.cue

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -607,8 +607,7 @@
607607
// Encrypt passwords.
608608
password_encryption?: string & "md5" | "scram-sha-256"
609609

610-
// Specifies which classes of statements will be logged by session audit logging.
611-
// "pgaudit.log"?: string & "ddl" | "function" | "misc" | "read" | "role" | "write" | "none" | "all" | "-ddl" | "-function" | "-misc" | "-read" | "-role" | "-write"
610+
// Specifies which classes of statements will be logged by session audit logging. Multiple classes can be provided using a comma-separated list and classes can be subtracted by prefacing the class with a - sign. Supported classes are: ddl, function, misc, read, role, write, none, all, -ddl, -function, -misc, -read, -role, -write.
612611
"pgaudit.log"?: string
613612

614613
// Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog.
@@ -893,17 +892,16 @@
893892
// Sets the planners estimate of the cost of a sequentially fetched disk page.
894893
seq_page_cost?: float & >=0
895894

896-
// Lists shared libraries to preload into each backend.
897-
session_preload_libraries?: string & "auto_explain" | "orafce" | "pg_bigm" | "pg_hint_plan" | "pg_prewarm" | "pg_similarity" | "pg_stat_statements" | "pg_transport" | "plprofiler"
895+
// Lists shared libraries to preload into each backend. Multiple libraries can be provided using a comma-separated list, e.g. 'pg_stat_statements, auto_explain'.
896+
session_preload_libraries?: string
898897

899898
// Sets the sessions behavior for triggers and rewrite rules.
900899
session_replication_role?: string & "origin" | "replica" | "local"
901900

902901
// (8kB) Sets the number of shared memory buffers used by the server.
903902
shared_buffers?: int & >=16 & <=1073741823 @storeResource(8KB)
904903

905-
// Lists shared libraries to preload into server.
906-
// TODO: support enum list, e.g. shared_preload_libraries = 'pg_stat_statements, auto_explain'
904+
// Lists shared libraries to preload into server. Multiple libraries can be provided using a comma-separated list, e.g. 'pg_stat_statements, auto_explain'.
907905
shared_preload_libraries?: string
908906

909907
// Enables SSL connections.

addons/postgresql/config/pg15-config-constraint.cue

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -607,8 +607,7 @@
607607
// Encrypt passwords.
608608
password_encryption?: string & "md5" | "scram-sha-256"
609609

610-
// Specifies which classes of statements will be logged by session audit logging.
611-
// "pgaudit.log"?: string & "ddl" | "function" | "misc" | "read" | "role" | "write" | "none" | "all" | "-ddl" | "-function" | "-misc" | "-read" | "-role" | "-write"
610+
// Specifies which classes of statements will be logged by session audit logging. Multiple classes can be provided using a comma-separated list and classes can be subtracted by prefacing the class with a - sign. Supported classes are: ddl, function, misc, read, role, write, none, all, -ddl, -function, -misc, -read, -role, -write.
612611
"pgaudit.log"?: string
613612

614613
// Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog.
@@ -893,17 +892,16 @@
893892
// Sets the planners estimate of the cost of a sequentially fetched disk page.
894893
seq_page_cost?: float & >=0
895894

896-
// Lists shared libraries to preload into each backend.
897-
session_preload_libraries?: string & "auto_explain" | "orafce" | "pg_bigm" | "pg_hint_plan" | "pg_prewarm" | "pg_similarity" | "pg_stat_statements" | "pg_transport" | "plprofiler"
895+
// Lists shared libraries to preload into each backend. Multiple libraries can be provided using a comma-separated list, e.g. 'pg_stat_statements, auto_explain'.
896+
session_preload_libraries?: string
898897

899898
// Sets the sessions behavior for triggers and rewrite rules.
900899
session_replication_role?: string & "origin" | "replica" | "local"
901900

902901
// (8kB) Sets the number of shared memory buffers used by the server.
903902
shared_buffers?: int & >=16 & <=1073741823 @storeResource(8KB)
904903

905-
// Lists shared libraries to preload into server.
906-
// TODO: support enum list, e.g. shared_preload_libraries = 'pg_stat_statements, auto_explain'
904+
// Lists shared libraries to preload into server. Multiple libraries can be provided using a comma-separated list, e.g. 'pg_stat_statements, auto_explain'.
907905
shared_preload_libraries?: string
908906

909907
// Enables SSL connections.

addons/postgresql/config/pg16-config-constraint.cue

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -604,8 +604,7 @@
604604
// Encrypt passwords.
605605
password_encryption?: string & "md5" | "scram-sha-256"
606606

607-
// Specifies which classes of statements will be logged by session audit logging.
608-
// "pgaudit.log"?: string & "ddl" | "function" | "misc" | "read" | "role" | "write" | "none" | "all" | "-ddl" | "-function" | "-misc" | "-read" | "-role" | "-write"
607+
// Specifies which classes of statements will be logged by session audit logging. Multiple classes can be provided using a comma-separated list and classes can be subtracted by prefacing the class with a - sign. Supported classes are: ddl, function, misc, read, role, write, none, all, -ddl, -function, -misc, -read, -role, -write.
609608
"pgaudit.log"?: string
610609

611610
// Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog.
@@ -890,17 +889,16 @@
890889
// Sets the planners estimate of the cost of a sequentially fetched disk page.
891890
seq_page_cost?: float & >=0
892891

893-
// Lists shared libraries to preload into each backend.
894-
session_preload_libraries?: string & "auto_explain" | "orafce" | "pg_bigm" | "pg_hint_plan" | "pg_prewarm" | "pg_similarity" | "pg_stat_statements" | "pg_transport" | "plprofiler"
892+
// Lists shared libraries to preload into each backend. Multiple libraries can be provided using a comma-separated list, e.g. 'pg_stat_statements, auto_explain'.
893+
session_preload_libraries?: string
895894

896895
// Sets the sessions behavior for triggers and rewrite rules.
897896
session_replication_role?: string & "origin" | "replica" | "local"
898897

899898
// (8kB) Sets the number of shared memory buffers used by the server.
900899
shared_buffers?: int & >=16 & <=1073741823 @storeResource(8KB)
901900

902-
// Lists shared libraries to preload into server.
903-
// TODO: support enum list, e.g. shared_preload_libraries = 'pg_stat_statements, auto_explain'
901+
// Lists shared libraries to preload into server. Multiple libraries can be provided using a comma-separated list, e.g. 'pg_stat_statements, auto_explain'.
904902
shared_preload_libraries?: string
905903

906904
// Enables SSL connections.

addons/postgresql/config/pg17-config-constraint.cue

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -601,8 +601,7 @@
601601
// Encrypt passwords.
602602
password_encryption?: string & "md5" | "scram-sha-256"
603603

604-
// Specifies which classes of statements will be logged by session audit logging.
605-
// "pgaudit.log"?: string & "ddl" | "function" | "misc" | "read" | "role" | "write" | "none" | "all" | "-ddl" | "-function" | "-misc" | "-read" | "-role" | "-write"
604+
// Specifies which classes of statements will be logged by session audit logging. Multiple classes can be provided using a comma-separated list and classes can be subtracted by prefacing the class with a - sign. Supported classes are: ddl, function, misc, read, role, write, none, all, -ddl, -function, -misc, -read, -role, -write.
606605
"pgaudit.log"?: string
607606

608607
// Specifies that session logging should be enabled in the case where all relations in a statement are in pg_catalog.
@@ -887,17 +886,16 @@
887886
// Sets the planners estimate of the cost of a sequentially fetched disk page.
888887
seq_page_cost?: float & >=0
889888

890-
// Lists shared libraries to preload into each backend.
891-
session_preload_libraries?: string & "auto_explain" | "orafce" | "pg_bigm" | "pg_hint_plan" | "pg_prewarm" | "pg_similarity" | "pg_stat_statements" | "pg_transport" | "plprofiler"
889+
// Lists shared libraries to preload into each backend. Multiple libraries can be provided using a comma-separated list, e.g. 'pg_stat_statements, auto_explain'.
890+
session_preload_libraries?: string
892891

893892
// Sets the sessions behavior for triggers and rewrite rules.
894893
session_replication_role?: string & "origin" | "replica" | "local"
895894

896895
// (8kB) Sets the number of shared memory buffers used by the server.
897896
shared_buffers?: int & >=16 & <=1073741823 @storeResource(8KB)
898897

899-
// Lists shared libraries to preload into server.
900-
// TODO: support enum list, e.g. shared_preload_libraries = 'pg_stat_statements, auto_explain'
898+
// Lists shared libraries to preload into server. Multiple libraries can be provided using a comma-separated list, e.g. 'pg_stat_statements, auto_explain'.
901899
shared_preload_libraries?: string
902900

903901
// Enables SSL connections.

0 commit comments

Comments
 (0)