PostgreSQL Source Code  git master
reloptions.h File Reference
#include "access/amapi.h"
#include "access/htup.h"
#include "access/tupdesc.h"
#include "nodes/pg_list.h"
#include "storage/lock.h"
Include dependency graph for reloptions.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  relopt_gen
 
struct  relopt_value
 
struct  relopt_bool
 
struct  relopt_int
 
struct  relopt_real
 
struct  relopt_enum_elt_def
 
struct  relopt_enum
 
struct  relopt_string
 
struct  relopt_parse_elt
 
struct  local_relopt
 
struct  local_relopts
 

Macros

#define HEAP_RELOPT_NAMESPACES   { "toast", NULL }
 
#define GET_STRING_RELOPTION(optstruct, member)
 

Typedefs

typedef enum relopt_type relopt_type
 
typedef enum relopt_kind relopt_kind
 
typedef struct relopt_gen relopt_gen
 
typedef struct relopt_value relopt_value
 
typedef struct relopt_bool relopt_bool
 
typedef struct relopt_int relopt_int
 
typedef struct relopt_real relopt_real
 
typedef struct relopt_enum_elt_def relopt_enum_elt_def
 
typedef struct relopt_enum relopt_enum
 
typedef void(* validate_string_relopt) (const char *value)
 
typedef Size(* fill_string_relopt) (const char *value, void *ptr)
 
typedef void(* relopts_validator) (void *parsed_options, relopt_value *vals, int nvals)
 
typedef struct relopt_string relopt_string
 
typedef struct local_relopt local_relopt
 
typedef struct local_relopts local_relopts
 

Enumerations

enum  relopt_type {
  RELOPT_TYPE_BOOL , RELOPT_TYPE_INT , RELOPT_TYPE_REAL , RELOPT_TYPE_ENUM ,
  RELOPT_TYPE_STRING
}
 
enum  relopt_kind {
  RELOPT_KIND_LOCAL = 0 , RELOPT_KIND_HEAP = (1 << 0) , RELOPT_KIND_TOAST = (1 << 1) , RELOPT_KIND_BTREE = (1 << 2) ,
  RELOPT_KIND_HASH = (1 << 3) , RELOPT_KIND_GIN = (1 << 4) , RELOPT_KIND_GIST = (1 << 5) , RELOPT_KIND_ATTRIBUTE = (1 << 6) ,
  RELOPT_KIND_TABLESPACE = (1 << 7) , RELOPT_KIND_SPGIST = (1 << 8) , RELOPT_KIND_VIEW = (1 << 9) , RELOPT_KIND_BRIN = (1 << 10) ,
  RELOPT_KIND_PARTITIONED = (1 << 11) , RELOPT_KIND_LAST_DEFAULT = RELOPT_KIND_PARTITIONED , RELOPT_KIND_MAX = (1 << 30)
}
 

Functions

relopt_kind add_reloption_kind (void)
 
void add_bool_reloption (bits32 kinds, const char *name, const char *desc, bool default_val, LOCKMODE lockmode)
 
void add_int_reloption (bits32 kinds, const char *name, const char *desc, int default_val, int min_val, int max_val, LOCKMODE lockmode)
 
void add_real_reloption (bits32 kinds, const char *name, const char *desc, double default_val, double min_val, double max_val, LOCKMODE lockmode)
 
void add_enum_reloption (bits32 kinds, const char *name, const char *desc, relopt_enum_elt_def *members, int default_val, const char *detailmsg, LOCKMODE lockmode)
 
void add_string_reloption (bits32 kinds, const char *name, const char *desc, const char *default_val, validate_string_relopt validator, LOCKMODE lockmode)
 
void init_local_reloptions (local_relopts *relopts, Size relopt_struct_size)
 
void register_reloptions_validator (local_relopts *relopts, relopts_validator validator)
 
void add_local_bool_reloption (local_relopts *relopts, const char *name, const char *desc, bool default_val, int offset)
 
void add_local_int_reloption (local_relopts *relopts, const char *name, const char *desc, int default_val, int min_val, int max_val, int offset)
 
void add_local_real_reloption (local_relopts *relopts, const char *name, const char *desc, double default_val, double min_val, double max_val, int offset)
 
void add_local_enum_reloption (local_relopts *relopts, const char *name, const char *desc, relopt_enum_elt_def *members, int default_val, const char *detailmsg, int offset)
 
void add_local_string_reloption (local_relopts *relopts, const char *name, const char *desc, const char *default_val, validate_string_relopt validator, fill_string_relopt filler, int offset)
 
Datum transformRelOptions (Datum oldOptions, List *defList, const char *namspace, char *validnsps[], bool acceptOidsOff, bool isReset)
 
ListuntransformRelOptions (Datum options)
 
byteaextractRelOptions (HeapTuple tuple, TupleDesc tupdesc, amoptions_function amoptions)
 
void * build_reloptions (Datum reloptions, bool validate, relopt_kind kind, Size relopt_struct_size, const relopt_parse_elt *relopt_elems, int num_relopt_elems)
 
void * build_local_reloptions (local_relopts *relopts, Datum options, bool validate)
 
byteadefault_reloptions (Datum reloptions, bool validate, relopt_kind kind)
 
byteaheap_reloptions (char relkind, Datum reloptions, bool validate)
 
byteaview_reloptions (Datum reloptions, bool validate)
 
byteapartitioned_table_reloptions (Datum reloptions, bool validate)
 
byteaindex_reloptions (amoptions_function amoptions, Datum reloptions, bool validate)
 
byteaattribute_reloptions (Datum reloptions, bool validate)
 
byteatablespace_reloptions (Datum reloptions, bool validate)
 
LOCKMODE AlterTableGetRelOptionsLockLevel (List *defList)
 

Macro Definition Documentation

◆ GET_STRING_RELOPTION

#define GET_STRING_RELOPTION (   optstruct,
  member 
)
Value:
((optstruct)->member == 0 ? NULL : \
(char *)(optstruct) + (optstruct)->member)

Definition at line 178 of file reloptions.h.

◆ HEAP_RELOPT_NAMESPACES

#define HEAP_RELOPT_NAMESPACES   { "toast", NULL }

Definition at line 61 of file reloptions.h.

Typedef Documentation

◆ fill_string_relopt

typedef Size(* fill_string_relopt) (const char *value, void *ptr)

Definition at line 134 of file reloptions.h.

◆ local_relopt

typedef struct local_relopt local_relopt

◆ local_relopts

typedef struct local_relopts local_relopts

◆ relopt_bool

typedef struct relopt_bool relopt_bool

◆ relopt_enum

typedef struct relopt_enum relopt_enum

◆ relopt_enum_elt_def

◆ relopt_gen

typedef struct relopt_gen relopt_gen

◆ relopt_int

typedef struct relopt_int relopt_int

◆ relopt_kind

typedef enum relopt_kind relopt_kind

◆ relopt_real

typedef struct relopt_real relopt_real

◆ relopt_string

typedef struct relopt_string relopt_string

◆ relopt_type

typedef enum relopt_type relopt_type

◆ relopt_value

typedef struct relopt_value relopt_value

◆ relopts_validator

typedef void(* relopts_validator) (void *parsed_options, relopt_value *vals, int nvals)

Definition at line 137 of file reloptions.h.

◆ validate_string_relopt

typedef void(* validate_string_relopt) (const char *value)

Definition at line 133 of file reloptions.h.

Enumeration Type Documentation

◆ relopt_kind

Enumerator
RELOPT_KIND_LOCAL 
RELOPT_KIND_HEAP 
RELOPT_KIND_TOAST 
RELOPT_KIND_BTREE 
RELOPT_KIND_HASH 
RELOPT_KIND_GIN 
RELOPT_KIND_GIST 
RELOPT_KIND_ATTRIBUTE 
RELOPT_KIND_TABLESPACE 
RELOPT_KIND_SPGIST 
RELOPT_KIND_VIEW 
RELOPT_KIND_BRIN 
RELOPT_KIND_PARTITIONED 
RELOPT_KIND_LAST_DEFAULT 
RELOPT_KIND_MAX 

Definition at line 39 of file reloptions.h.

40 {
42  RELOPT_KIND_HEAP = (1 << 0),
43  RELOPT_KIND_TOAST = (1 << 1),
44  RELOPT_KIND_BTREE = (1 << 2),
45  RELOPT_KIND_HASH = (1 << 3),
46  RELOPT_KIND_GIN = (1 << 4),
47  RELOPT_KIND_GIST = (1 << 5),
48  RELOPT_KIND_ATTRIBUTE = (1 << 6),
49  RELOPT_KIND_TABLESPACE = (1 << 7),
50  RELOPT_KIND_SPGIST = (1 << 8),
51  RELOPT_KIND_VIEW = (1 << 9),
52  RELOPT_KIND_BRIN = (1 << 10),
53  RELOPT_KIND_PARTITIONED = (1 << 11),
54  /* if you add a new kind, make sure you update "last_default" too */
56  /* some compilers treat enums as signed ints, so we can't use 1 << 31 */
57  RELOPT_KIND_MAX = (1 << 30)
58 } relopt_kind;
relopt_kind
Definition: reloptions.h:40
@ RELOPT_KIND_LAST_DEFAULT
Definition: reloptions.h:55
@ RELOPT_KIND_ATTRIBUTE
Definition: reloptions.h:48
@ RELOPT_KIND_TOAST
Definition: reloptions.h:43
@ RELOPT_KIND_LOCAL
Definition: reloptions.h:41
@ RELOPT_KIND_SPGIST
Definition: reloptions.h:50
@ RELOPT_KIND_MAX
Definition: reloptions.h:57
@ RELOPT_KIND_GIST
Definition: reloptions.h:47
@ RELOPT_KIND_VIEW
Definition: reloptions.h:51
@ RELOPT_KIND_HEAP
Definition: reloptions.h:42
@ RELOPT_KIND_TABLESPACE
Definition: reloptions.h:49
@ RELOPT_KIND_GIN
Definition: reloptions.h:46
@ RELOPT_KIND_HASH
Definition: reloptions.h:45
@ RELOPT_KIND_PARTITIONED
Definition: reloptions.h:53
@ RELOPT_KIND_BRIN
Definition: reloptions.h:52
@ RELOPT_KIND_BTREE
Definition: reloptions.h:44

◆ relopt_type

Enumerator
RELOPT_TYPE_BOOL 
RELOPT_TYPE_INT 
RELOPT_TYPE_REAL 
RELOPT_TYPE_ENUM 
RELOPT_TYPE_STRING 

Definition at line 29 of file reloptions.h.

30 {
36 } relopt_type;
relopt_type
Definition: reloptions.h:30
@ RELOPT_TYPE_ENUM
Definition: reloptions.h:34
@ RELOPT_TYPE_INT
Definition: reloptions.h:32
@ RELOPT_TYPE_BOOL
Definition: reloptions.h:31
@ RELOPT_TYPE_REAL
Definition: reloptions.h:33
@ RELOPT_TYPE_STRING
Definition: reloptions.h:35

Function Documentation

◆ add_bool_reloption()

void add_bool_reloption ( bits32  kinds,
const char *  name,
const char *  desc,
bool  default_val,
LOCKMODE  lockmode 
)

Definition at line 851 of file reloptions.c.

853 {
854  relopt_bool *newoption = init_bool_reloption(kinds, name, desc,
855  default_val, lockmode);
856 
857  add_reloption((relopt_gen *) newoption);
858 }
const char * name
Definition: encode.c:561
static void add_reloption(relopt_gen *newoption)
Definition: reloptions.c:702
static relopt_bool * init_bool_reloption(bits32 kinds, const char *name, const char *desc, bool default_val, LOCKMODE lockmode)
Definition: reloptions.c:834

References add_reloption(), init_bool_reloption(), and name.

Referenced by create_reloptions_table().

◆ add_enum_reloption()

void add_enum_reloption ( bits32  kinds,
const char *  name,
const char *  desc,
relopt_enum_elt_def members,
int  default_val,
const char *  detailmsg,
LOCKMODE  lockmode 
)

Definition at line 1020 of file reloptions.c.

1023 {
1024  relopt_enum *newoption = init_enum_reloption(kinds, name, desc,
1025  members, default_val,
1026  detailmsg, lockmode);
1027 
1028  add_reloption((relopt_gen *) newoption);
1029 }
static relopt_enum * init_enum_reloption(bits32 kinds, const char *name, const char *desc, relopt_enum_elt_def *members, int default_val, const char *detailmsg, LOCKMODE lockmode)
Definition: reloptions.c:991

References add_reloption(), init_enum_reloption(), and name.

Referenced by create_reloptions_table().

◆ add_int_reloption()

void add_int_reloption ( bits32  kinds,
const char *  name,
const char *  desc,
int  default_val,
int  min_val,
int  max_val,
LOCKMODE  lockmode 
)

Definition at line 903 of file reloptions.c.

905 {
906  relopt_int *newoption = init_int_reloption(kinds, name, desc,
907  default_val, min_val,
908  max_val, lockmode);
909 
910  add_reloption((relopt_gen *) newoption);
911 }
static relopt_int * init_int_reloption(bits32 kinds, const char *name, const char *desc, int default_val, int min_val, int max_val, LOCKMODE lockmode)
Definition: reloptions.c:883

References add_reloption(), init_int_reloption(), and name.

Referenced by _PG_init(), and create_reloptions_table().

◆ add_local_bool_reloption()

void add_local_bool_reloption ( local_relopts relopts,
const char *  name,
const char *  desc,
bool  default_val,
int  offset 
)

Definition at line 867 of file reloptions.c.

869 {
871  name, desc,
872  default_val, 0);
873 
874  add_local_reloption(relopts, (relopt_gen *) newoption, offset);
875 }
static void add_local_reloption(local_relopts *relopts, relopt_gen *newoption, int offset)
Definition: reloptions.c:759

References add_local_reloption(), init_bool_reloption(), name, and RELOPT_KIND_LOCAL.

◆ add_local_enum_reloption()

void add_local_enum_reloption ( local_relopts relopts,
const char *  name,
const char *  desc,
relopt_enum_elt_def members,
int  default_val,
const char *  detailmsg,
int  offset 
)

Definition at line 1038 of file reloptions.c.

1041 {
1043  name, desc,
1044  members, default_val,
1045  detailmsg, 0);
1046 
1047  add_local_reloption(relopts, (relopt_gen *) newoption, offset);
1048 }

References add_local_reloption(), init_enum_reloption(), name, and RELOPT_KIND_LOCAL.

◆ add_local_int_reloption()

void add_local_int_reloption ( local_relopts relopts,
const char *  name,
const char *  desc,
int  default_val,
int  min_val,
int  max_val,
int  offset 
)

Definition at line 920 of file reloptions.c.

923 {
925  name, desc, default_val,
926  min_val, max_val, 0);
927 
928  add_local_reloption(relopts, (relopt_gen *) newoption, offset);
929 }

References add_local_reloption(), init_int_reloption(), name, and RELOPT_KIND_LOCAL.

Referenced by _ltree_gist_options(), brin_minmax_multi_options(), g_int_options(), g_intbig_options(), ghstore_options(), gtrgm_options(), gtsvector_options(), and ltree_gist_options().

◆ add_local_real_reloption()

void add_local_real_reloption ( local_relopts relopts,
const char *  name,
const char *  desc,
double  default_val,
double  min_val,
double  max_val,
int  offset 
)

Definition at line 974 of file reloptions.c.

977 {
979  name, desc,
980  default_val, min_val,
981  max_val, 0);
982 
983  add_local_reloption(relopts, (relopt_gen *) newoption, offset);
984 }
static relopt_real * init_real_reloption(bits32 kinds, const char *name, const char *desc, double default_val, double min_val, double max_val, LOCKMODE lockmode)
Definition: reloptions.c:936

References add_local_reloption(), init_real_reloption(), name, and RELOPT_KIND_LOCAL.

Referenced by brin_bloom_options().

◆ add_local_string_reloption()

void add_local_string_reloption ( local_relopts relopts,
const char *  name,
const char *  desc,
const char *  default_val,
validate_string_relopt  validator,
fill_string_relopt  filler,
int  offset 
)

Definition at line 1120 of file reloptions.c.

1124 {
1126  name, desc,
1127  default_val,
1128  validator, filler,
1129  0);
1130 
1131  add_local_reloption(relopts, (relopt_gen *) newoption, offset);
1132 }
static relopt_string * init_string_reloption(bits32 kinds, const char *name, const char *desc, const char *default_val, validate_string_relopt validator, fill_string_relopt filler, LOCKMODE lockmode)
Definition: reloptions.c:1055

References add_local_reloption(), init_string_reloption(), name, and RELOPT_KIND_LOCAL.

◆ add_real_reloption()

void add_real_reloption ( bits32  kinds,
const char *  name,
const char *  desc,
double  default_val,
double  min_val,
double  max_val,
LOCKMODE  lockmode 
)

Definition at line 956 of file reloptions.c.

959 {
960  relopt_real *newoption = init_real_reloption(kinds, name, desc,
961  default_val, min_val,
962  max_val, lockmode);
963 
964  add_reloption((relopt_gen *) newoption);
965 }

References add_reloption(), init_real_reloption(), and name.

Referenced by create_reloptions_table().

◆ add_reloption_kind()

relopt_kind add_reloption_kind ( void  )

Definition at line 685 of file reloptions.c.

686 {
687  /* don't hand out the last bit so that the enum's behavior is portable */
689  ereport(ERROR,
690  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
691  errmsg("user-defined relation parameter types limit exceeded")));
692  last_assigned_kind <<= 1;
694 }
int errcode(int sqlerrcode)
Definition: elog.c:695
int errmsg(const char *fmt,...)
Definition: elog.c:906
#define ERROR
Definition: elog.h:35
#define ereport(elevel,...)
Definition: elog.h:145
static bits32 last_assigned_kind
Definition: reloptions.c:556

References ereport, errcode(), errmsg(), ERROR, last_assigned_kind, and RELOPT_KIND_MAX.

Referenced by _PG_init(), and create_reloptions_table().

◆ add_string_reloption()

void add_string_reloption ( bits32  kinds,
const char *  name,
const char *  desc,
const char *  default_val,
validate_string_relopt  validator,
LOCKMODE  lockmode 
)

Definition at line 1100 of file reloptions.c.

1103 {
1104  relopt_string *newoption = init_string_reloption(kinds, name, desc,
1105  default_val,
1106  validator, NULL,
1107  lockmode);
1108 
1109  add_reloption((relopt_gen *) newoption);
1110 }

References add_reloption(), init_string_reloption(), and name.

Referenced by create_reloptions_table().

◆ AlterTableGetRelOptionsLockLevel()

LOCKMODE AlterTableGetRelOptionsLockLevel ( List defList)

Definition at line 2109 of file reloptions.c.

2110 {
2111  LOCKMODE lockmode = NoLock;
2112  ListCell *cell;
2113 
2114  if (defList == NIL)
2115  return AccessExclusiveLock;
2116 
2117  if (need_initialization)
2119 
2120  foreach(cell, defList)
2121  {
2122  DefElem *def = (DefElem *) lfirst(cell);
2123  int i;
2124 
2125  for (i = 0; relOpts[i]; i++)
2126  {
2127  if (strncmp(relOpts[i]->name,
2128  def->defname,
2129  relOpts[i]->namelen + 1) == 0)
2130  {
2131  if (lockmode < relOpts[i]->lockmode)
2132  lockmode = relOpts[i]->lockmode;
2133  }
2134  }
2135  }
2136 
2137  return lockmode;
2138 }
int i
Definition: isn.c:73
int LOCKMODE
Definition: lockdefs.h:26
#define NoLock
Definition: lockdefs.h:34
#define AccessExclusiveLock
Definition: lockdefs.h:43
#define lfirst(lc)
Definition: pg_list.h:170
#define NIL
Definition: pg_list.h:66
static void initialize_reloptions(void)
Definition: reloptions.c:582
static bool need_initialization
Definition: reloptions.c:560
static relopt_gen ** relOpts
Definition: reloptions.c:555
char * defname
Definition: parsenodes.h:777
LOCKMODE lockmode
Definition: reloptions.h:70
int namelen
Definition: reloptions.h:71

References AccessExclusiveLock, DefElem::defname, i, initialize_reloptions(), lfirst, relopt_gen::lockmode, name, relopt_gen::namelen, need_initialization, NIL, NoLock, and relOpts.

Referenced by AlterTableGetLockLevel().

◆ attribute_reloptions()

bytea* attribute_reloptions ( Datum  reloptions,
bool  validate 
)

Definition at line 2070 of file reloptions.c.

2071 {
2072  static const relopt_parse_elt tab[] = {
2073  {"n_distinct", RELOPT_TYPE_REAL, offsetof(AttributeOpts, n_distinct)},
2074  {"n_distinct_inherited", RELOPT_TYPE_REAL, offsetof(AttributeOpts, n_distinct_inherited)}
2075  };
2076 
2077  return (bytea *) build_reloptions(reloptions, validate,
2079  sizeof(AttributeOpts),
2080  tab, lengthof(tab));
2081 }
#define lengthof(array)
Definition: c.h:724
void * build_reloptions(Datum reloptions, bool validate, relopt_kind kind, Size relopt_struct_size, const relopt_parse_elt *relopt_elems, int num_relopt_elems)
Definition: reloptions.c:1910
Definition: c.h:623

References build_reloptions(), lengthof, RELOPT_KIND_ATTRIBUTE, and RELOPT_TYPE_REAL.

Referenced by ATExecSetOptions(), and get_attribute_options().

◆ build_local_reloptions()

void* build_local_reloptions ( local_relopts relopts,
Datum  options,
bool  validate 
)

Definition at line 1947 of file reloptions.c.

1948 {
1949  int noptions = list_length(relopts->options);
1950  relopt_parse_elt *elems = palloc(sizeof(*elems) * noptions);
1951  relopt_value *vals;
1952  void *opts;
1953  int i = 0;
1954  ListCell *lc;
1955 
1956  foreach(lc, relopts->options)
1957  {
1958  local_relopt *opt = lfirst(lc);
1959 
1960  elems[i].optname = opt->option->name;
1961  elems[i].opttype = opt->option->type;
1962  elems[i].offset = opt->offset;
1963 
1964  i++;
1965  }
1966 
1967  vals = parseLocalRelOptions(relopts, options, validate);
1969  fillRelOptions(opts, relopts->relopt_struct_size, vals, noptions, validate,
1970  elems, noptions);
1971 
1972  foreach(lc, relopts->validators)
1973  ((relopts_validator) lfirst(lc)) (opts, vals, noptions);
1974 
1975  if (elems)
1976  pfree(elems);
1977 
1978  return opts;
1979 }
void pfree(void *pointer)
Definition: mcxt.c:1306
void * palloc(Size size)
Definition: mcxt.c:1199
static AmcheckOptions opts
Definition: pg_amcheck.c:110
static int list_length(const List *l)
Definition: pg_list.h:150
static size_t noptions
static void * allocateReloptStruct(Size base, relopt_value *options, int numoptions)
Definition: reloptions.c:1704
static void fillRelOptions(void *rdopts, Size basesize, relopt_value *options, int numoptions, bool validate, const relopt_parse_elt *elems, int numelems)
Definition: reloptions.c:1744
static relopt_value * parseLocalRelOptions(local_relopts *relopts, Datum options, bool validate)
Definition: reloptions.c:1543
void(* relopts_validator)(void *parsed_options, relopt_value *vals, int nvals)
Definition: reloptions.h:137
relopt_gen * option
Definition: reloptions.h:160
List * validators
Definition: reloptions.h:168
List * options
Definition: reloptions.h:167
Size relopt_struct_size
Definition: reloptions.h:169
const char * name
Definition: reloptions.h:66
relopt_type type
Definition: reloptions.h:72
const char * optname
Definition: reloptions.h:152
relopt_type opttype
Definition: reloptions.h:153

References allocateReloptStruct(), fillRelOptions(), i, lfirst, list_length(), relopt_gen::name, noptions, relopt_parse_elt::offset, local_relopt::offset, local_relopt::option, local_relopts::options, relopt_parse_elt::optname, opts, relopt_parse_elt::opttype, palloc(), parseLocalRelOptions(), pfree(), local_relopts::relopt_struct_size, relopt_gen::type, and local_relopts::validators.

Referenced by index_opclass_options().

◆ build_reloptions()

void* build_reloptions ( Datum  reloptions,
bool  validate,
relopt_kind  kind,
Size  relopt_struct_size,
const relopt_parse_elt relopt_elems,
int  num_relopt_elems 
)

Definition at line 1910 of file reloptions.c.

1915 {
1916  int numoptions;
1918  void *rdopts;
1919 
1920  /* parse options specific to given relation option kind */
1921  options = parseRelOptions(reloptions, validate, kind, &numoptions);
1922  Assert(numoptions <= num_relopt_elems);
1923 
1924  /* if none set, we're done */
1925  if (numoptions == 0)
1926  {
1927  Assert(options == NULL);
1928  return NULL;
1929  }
1930 
1931  /* allocate and fill the structure */
1932  rdopts = allocateReloptStruct(relopt_struct_size, options, numoptions);
1933  fillRelOptions(rdopts, relopt_struct_size, options, numoptions,
1934  validate, relopt_elems, num_relopt_elems);
1935 
1936  pfree(options);
1937 
1938  return rdopts;
1939 }
Assert(fmt[strlen(fmt) - 1] !='\n')
static char ** options
static relopt_value * parseRelOptions(Datum options, bool validate, relopt_kind kind, int *numrelopts)
Definition: reloptions.c:1501

References allocateReloptStruct(), Assert(), fillRelOptions(), options, parseRelOptions(), and pfree().

Referenced by attribute_reloptions(), bloptions(), brinoptions(), btoptions(), default_reloptions(), dioptions(), ginoptions(), gistoptions(), hashoptions(), spgoptions(), tablespace_reloptions(), and view_reloptions().

◆ default_reloptions()

bytea* default_reloptions ( Datum  reloptions,
bool  validate,
relopt_kind  kind 
)

Definition at line 1840 of file reloptions.c.

1841 {
1842  static const relopt_parse_elt tab[] = {
1843  {"fillfactor", RELOPT_TYPE_INT, offsetof(StdRdOptions, fillfactor)},
1844  {"autovacuum_enabled", RELOPT_TYPE_BOOL,
1845  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, enabled)},
1846  {"autovacuum_vacuum_threshold", RELOPT_TYPE_INT,
1847  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, vacuum_threshold)},
1848  {"autovacuum_vacuum_insert_threshold", RELOPT_TYPE_INT,
1849  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, vacuum_ins_threshold)},
1850  {"autovacuum_analyze_threshold", RELOPT_TYPE_INT,
1851  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, analyze_threshold)},
1852  {"autovacuum_vacuum_cost_limit", RELOPT_TYPE_INT,
1853  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, vacuum_cost_limit)},
1854  {"autovacuum_freeze_min_age", RELOPT_TYPE_INT,
1855  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, freeze_min_age)},
1856  {"autovacuum_freeze_max_age", RELOPT_TYPE_INT,
1857  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, freeze_max_age)},
1858  {"autovacuum_freeze_table_age", RELOPT_TYPE_INT,
1859  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, freeze_table_age)},
1860  {"autovacuum_multixact_freeze_min_age", RELOPT_TYPE_INT,
1861  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, multixact_freeze_min_age)},
1862  {"autovacuum_multixact_freeze_max_age", RELOPT_TYPE_INT,
1863  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, multixact_freeze_max_age)},
1864  {"autovacuum_multixact_freeze_table_age", RELOPT_TYPE_INT,
1865  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, multixact_freeze_table_age)},
1866  {"log_autovacuum_min_duration", RELOPT_TYPE_INT,
1867  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, log_min_duration)},
1868  {"toast_tuple_target", RELOPT_TYPE_INT,
1869  offsetof(StdRdOptions, toast_tuple_target)},
1870  {"autovacuum_vacuum_cost_delay", RELOPT_TYPE_REAL,
1871  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, vacuum_cost_delay)},
1872  {"autovacuum_vacuum_scale_factor", RELOPT_TYPE_REAL,
1873  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, vacuum_scale_factor)},
1874  {"autovacuum_vacuum_insert_scale_factor", RELOPT_TYPE_REAL,
1875  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, vacuum_ins_scale_factor)},
1876  {"autovacuum_analyze_scale_factor", RELOPT_TYPE_REAL,
1877  offsetof(StdRdOptions, autovacuum) + offsetof(AutoVacOpts, analyze_scale_factor)},
1878  {"user_catalog_table", RELOPT_TYPE_BOOL,
1879  offsetof(StdRdOptions, user_catalog_table)},
1880  {"parallel_workers", RELOPT_TYPE_INT,
1881  offsetof(StdRdOptions, parallel_workers)},
1882  {"vacuum_index_cleanup", RELOPT_TYPE_ENUM,
1883  offsetof(StdRdOptions, vacuum_index_cleanup)},
1884  {"vacuum_truncate", RELOPT_TYPE_BOOL,
1885  offsetof(StdRdOptions, vacuum_truncate)}
1886  };
1887 
1888  return (bytea *) build_reloptions(reloptions, validate, kind,
1889  sizeof(StdRdOptions),
1890  tab, lengthof(tab));
1891 }
int fillfactor
Definition: pgbench.c:196

References build_reloptions(), fillfactor, lengthof, RELOPT_TYPE_BOOL, RELOPT_TYPE_ENUM, RELOPT_TYPE_INT, and RELOPT_TYPE_REAL.

Referenced by heap_reloptions().

◆ extractRelOptions()

bytea* extractRelOptions ( HeapTuple  tuple,
TupleDesc  tupdesc,
amoptions_function  amoptions 
)

Definition at line 1381 of file reloptions.c.

1383 {
1384  bytea *options;
1385  bool isnull;
1386  Datum datum;
1387  Form_pg_class classForm;
1388 
1389  datum = fastgetattr(tuple,
1390  Anum_pg_class_reloptions,
1391  tupdesc,
1392  &isnull);
1393  if (isnull)
1394  return NULL;
1395 
1396  classForm = (Form_pg_class) GETSTRUCT(tuple);
1397 
1398  /* Parse into appropriate format; don't error out here */
1399  switch (classForm->relkind)
1400  {
1401  case RELKIND_RELATION:
1402  case RELKIND_TOASTVALUE:
1403  case RELKIND_MATVIEW:
1404  options = heap_reloptions(classForm->relkind, datum, false);
1405  break;
1406  case RELKIND_PARTITIONED_TABLE:
1407  options = partitioned_table_reloptions(datum, false);
1408  break;
1409  case RELKIND_VIEW:
1410  options = view_reloptions(datum, false);
1411  break;
1412  case RELKIND_INDEX:
1413  case RELKIND_PARTITIONED_INDEX:
1414  options = index_reloptions(amoptions, datum, false);
1415  break;
1416  case RELKIND_FOREIGN_TABLE:
1417  options = NULL;
1418  break;
1419  default:
1420  Assert(false); /* can't get here */
1421  options = NULL; /* keep compiler quiet */
1422  break;
1423  }
1424 
1425  return options;
1426 }
#define GETSTRUCT(TUP)
Definition: htup_details.h:649
static Datum fastgetattr(HeapTuple tup, int attnum, TupleDesc tupleDesc, bool *isnull)
Definition: htup_details.h:745
FormData_pg_class * Form_pg_class
Definition: pg_class.h:153
uintptr_t Datum
Definition: postgres.h:412
bytea * index_reloptions(amoptions_function amoptions, Datum reloptions, bool validate)
Definition: reloptions.c:2055
bytea * heap_reloptions(char relkind, Datum reloptions, bool validate)
Definition: reloptions.c:2020
bytea * view_reloptions(Datum reloptions, bool validate)
Definition: reloptions.c:1999
bytea * partitioned_table_reloptions(Datum reloptions, bool validate)
Definition: reloptions.c:1985

References Assert(), fastgetattr(), GETSTRUCT, heap_reloptions(), index_reloptions(), options, partitioned_table_reloptions(), and view_reloptions().

Referenced by extract_autovac_opts(), and RelationParseRelOptions().

◆ heap_reloptions()

bytea* heap_reloptions ( char  relkind,
Datum  reloptions,
bool  validate 
)

Definition at line 2020 of file reloptions.c.

2021 {
2022  StdRdOptions *rdopts;
2023 
2024  switch (relkind)
2025  {
2026  case RELKIND_TOASTVALUE:
2027  rdopts = (StdRdOptions *)
2028  default_reloptions(reloptions, validate, RELOPT_KIND_TOAST);
2029  if (rdopts != NULL)
2030  {
2031  /* adjust default-only parameters for TOAST relations */
2032  rdopts->fillfactor = 100;
2033  rdopts->autovacuum.analyze_threshold = -1;
2034  rdopts->autovacuum.analyze_scale_factor = -1;
2035  }
2036  return (bytea *) rdopts;
2037  case RELKIND_RELATION:
2038  case RELKIND_MATVIEW:
2039  return default_reloptions(reloptions, validate, RELOPT_KIND_HEAP);
2040  default:
2041  /* other relkinds are not supported */
2042  return NULL;
2043  }
2044 }
bytea * default_reloptions(Datum reloptions, bool validate, relopt_kind kind)
Definition: reloptions.c:1840
int analyze_threshold
Definition: rel.h:309
float8 analyze_scale_factor
Definition: rel.h:321
int fillfactor
Definition: rel.h:335
AutoVacOpts autovacuum
Definition: rel.h:337

References AutoVacOpts::analyze_scale_factor, AutoVacOpts::analyze_threshold, StdRdOptions::autovacuum, default_reloptions(), StdRdOptions::fillfactor, RELOPT_KIND_HEAP, and RELOPT_KIND_TOAST.

Referenced by ATExecSetRelOptions(), create_ctas_internal(), DefineRelation(), extractRelOptions(), and ProcessUtilitySlow().

◆ index_reloptions()

bytea* index_reloptions ( amoptions_function  amoptions,
Datum  reloptions,
bool  validate 
)

Definition at line 2055 of file reloptions.c.

2056 {
2057  Assert(amoptions != NULL);
2058 
2059  /* Assume function is strict */
2060  if (!PointerIsValid(DatumGetPointer(reloptions)))
2061  return NULL;
2062 
2063  return amoptions(reloptions, validate);
2064 }
#define PointerIsValid(pointer)
Definition: c.h:699
static Pointer DatumGetPointer(Datum X)
Definition: postgres.h:660

References Assert(), DatumGetPointer(), and PointerIsValid.

Referenced by ATExecSetRelOptions(), DefineIndex(), and extractRelOptions().

◆ init_local_reloptions()

void init_local_reloptions ( local_relopts relopts,
Size  relopt_struct_size 
)

◆ partitioned_table_reloptions()

bytea* partitioned_table_reloptions ( Datum  reloptions,
bool  validate 
)

Definition at line 1985 of file reloptions.c.

1986 {
1987  if (validate && reloptions)
1988  ereport(ERROR,
1989  errcode(ERRCODE_WRONG_OBJECT_TYPE),
1990  errmsg("cannot specify storage parameters for a partitioned table"),
1991  errhint("Specify storage parameters for its leaf partitions, instead."));
1992  return NULL;
1993 }
int errhint(const char *fmt,...)
Definition: elog.c:1153

References ereport, errcode(), errhint(), errmsg(), and ERROR.

Referenced by ATExecSetRelOptions(), DefineRelation(), and extractRelOptions().

◆ register_reloptions_validator()

void register_reloptions_validator ( local_relopts relopts,
relopts_validator  validator 
)

Definition at line 749 of file reloptions.c.

750 {
751  relopts->validators = lappend(relopts->validators, validator);
752 }
List * lappend(List *list, void *datum)
Definition: list.c:338

References lappend(), and local_relopts::validators.

◆ tablespace_reloptions()

bytea* tablespace_reloptions ( Datum  reloptions,
bool  validate 
)

Definition at line 2087 of file reloptions.c.

2088 {
2089  static const relopt_parse_elt tab[] = {
2090  {"random_page_cost", RELOPT_TYPE_REAL, offsetof(TableSpaceOpts, random_page_cost)},
2091  {"seq_page_cost", RELOPT_TYPE_REAL, offsetof(TableSpaceOpts, seq_page_cost)},
2092  {"effective_io_concurrency", RELOPT_TYPE_INT, offsetof(TableSpaceOpts, effective_io_concurrency)},
2093  {"maintenance_io_concurrency", RELOPT_TYPE_INT, offsetof(TableSpaceOpts, maintenance_io_concurrency)}
2094  };
2095 
2096  return (bytea *) build_reloptions(reloptions, validate,
2098  sizeof(TableSpaceOpts),
2099  tab, lengthof(tab));
2100 }
int maintenance_io_concurrency
Definition: bufmgr.c:152
int effective_io_concurrency
Definition: bufmgr.c:145
double random_page_cost
Definition: costsize.c:121
double seq_page_cost
Definition: costsize.c:120

References build_reloptions(), effective_io_concurrency, lengthof, maintenance_io_concurrency, random_page_cost, RELOPT_KIND_TABLESPACE, RELOPT_TYPE_INT, RELOPT_TYPE_REAL, and seq_page_cost.

Referenced by AlterTableSpaceOptions(), CreateTableSpace(), and get_tablespace().

◆ transformRelOptions()

Datum transformRelOptions ( Datum  oldOptions,
List defList,
const char *  namspace,
char *  validnsps[],
bool  acceptOidsOff,
bool  isReset 
)

Definition at line 1158 of file reloptions.c.

1160 {
1161  Datum result;
1162  ArrayBuildState *astate;
1163  ListCell *cell;
1164 
1165  /* no change if empty list */
1166  if (defList == NIL)
1167  return oldOptions;
1168 
1169  /* We build new array using accumArrayResult */
1170  astate = NULL;
1171 
1172  /* Copy any oldOptions that aren't to be replaced */
1173  if (PointerIsValid(DatumGetPointer(oldOptions)))
1174  {
1175  ArrayType *array = DatumGetArrayTypeP(oldOptions);
1176  Datum *oldoptions;
1177  int noldoptions;
1178  int i;
1179 
1180  deconstruct_array_builtin(array, TEXTOID, &oldoptions, NULL, &noldoptions);
1181 
1182  for (i = 0; i < noldoptions; i++)
1183  {
1184  char *text_str = VARDATA(oldoptions[i]);
1185  int text_len = VARSIZE(oldoptions[i]) - VARHDRSZ;
1186 
1187  /* Search for a match in defList */
1188  foreach(cell, defList)
1189  {
1190  DefElem *def = (DefElem *) lfirst(cell);
1191  int kw_len;
1192 
1193  /* ignore if not in the same namespace */
1194  if (namspace == NULL)
1195  {
1196  if (def->defnamespace != NULL)
1197  continue;
1198  }
1199  else if (def->defnamespace == NULL)
1200  continue;
1201  else if (strcmp(def->defnamespace, namspace) != 0)
1202  continue;
1203 
1204  kw_len = strlen(def->defname);
1205  if (text_len > kw_len && text_str[kw_len] == '=' &&
1206  strncmp(text_str, def->defname, kw_len) == 0)
1207  break;
1208  }
1209  if (!cell)
1210  {
1211  /* No match, so keep old option */
1212  astate = accumArrayResult(astate, oldoptions[i],
1213  false, TEXTOID,
1215  }
1216  }
1217  }
1218 
1219  /*
1220  * If CREATE/SET, add new options to array; if RESET, just check that the
1221  * user didn't say RESET (option=val). (Must do this because the grammar
1222  * doesn't enforce it.)
1223  */
1224  foreach(cell, defList)
1225  {
1226  DefElem *def = (DefElem *) lfirst(cell);
1227 
1228  if (isReset)
1229  {
1230  if (def->arg != NULL)
1231  ereport(ERROR,
1232  (errcode(ERRCODE_SYNTAX_ERROR),
1233  errmsg("RESET must not include values for parameters")));
1234  }
1235  else
1236  {
1237  text *t;
1238  const char *value;
1239  Size len;
1240 
1241  /*
1242  * Error out if the namespace is not valid. A NULL namespace is
1243  * always valid.
1244  */
1245  if (def->defnamespace != NULL)
1246  {
1247  bool valid = false;
1248  int i;
1249 
1250  if (validnsps)
1251  {
1252  for (i = 0; validnsps[i]; i++)
1253  {
1254  if (strcmp(def->defnamespace, validnsps[i]) == 0)
1255  {
1256  valid = true;
1257  break;
1258  }
1259  }
1260  }
1261 
1262  if (!valid)
1263  ereport(ERROR,
1264  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
1265  errmsg("unrecognized parameter namespace \"%s\"",
1266  def->defnamespace)));
1267  }
1268 
1269  /* ignore if not in the same namespace */
1270  if (namspace == NULL)
1271  {
1272  if (def->defnamespace != NULL)
1273  continue;
1274  }
1275  else if (def->defnamespace == NULL)
1276  continue;
1277  else if (strcmp(def->defnamespace, namspace) != 0)
1278  continue;
1279 
1280  /*
1281  * Flatten the DefElem into a text string like "name=arg". If we
1282  * have just "name", assume "name=true" is meant. Note: the
1283  * namespace is not output.
1284  */
1285  if (def->arg != NULL)
1286  value = defGetString(def);
1287  else
1288  value = "true";
1289 
1290  /*
1291  * This is not a great place for this test, but there's no other
1292  * convenient place to filter the option out. As WITH (oids =
1293  * false) will be removed someday, this seems like an acceptable
1294  * amount of ugly.
1295  */
1296  if (acceptOidsOff && def->defnamespace == NULL &&
1297  strcmp(def->defname, "oids") == 0)
1298  {
1299  if (defGetBoolean(def))
1300  ereport(ERROR,
1301  (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1302  errmsg("tables declared WITH OIDS are not supported")));
1303  /* skip over option, reloptions machinery doesn't know it */
1304  continue;
1305  }
1306 
1307  len = VARHDRSZ + strlen(def->defname) + 1 + strlen(value);
1308  /* +1 leaves room for sprintf's trailing null */
1309  t = (text *) palloc(len + 1);
1310  SET_VARSIZE(t, len);
1311  sprintf(VARDATA(t), "%s=%s", def->defname, value);
1312 
1313  astate = accumArrayResult(astate, PointerGetDatum(t),
1314  false, TEXTOID,
1316  }
1317  }
1318 
1319  if (astate)
1320  result = makeArrayResult(astate, CurrentMemoryContext);
1321  else
1322  result = (Datum) 0;
1323 
1324  return result;
1325 }
#define DatumGetArrayTypeP(X)
Definition: array.h:254
ArrayBuildState * accumArrayResult(ArrayBuildState *astate, Datum dvalue, bool disnull, Oid element_type, MemoryContext rcontext)
Definition: arrayfuncs.c:5277
void deconstruct_array_builtin(ArrayType *array, Oid elmtype, Datum **elemsp, bool **nullsp, int *nelemsp)
Definition: arrayfuncs.c:3642
Datum makeArrayResult(ArrayBuildState *astate, MemoryContext rcontext)
Definition: arrayfuncs.c:5341
#define VARHDRSZ
Definition: c.h:628
size_t Size
Definition: c.h:541
bool defGetBoolean(DefElem *def)
Definition: define.c:108
char * defGetString(DefElem *def)
Definition: define.c:49
static struct @143 value
MemoryContext CurrentMemoryContext
Definition: mcxt.c:124
const void size_t len
#define sprintf
Definition: port.h:240
static Datum PointerGetDatum(const void *X)
Definition: postgres.h:670
#define VARDATA(PTR)
Definition: postgres.h:316
#define SET_VARSIZE(PTR, len)
Definition: postgres.h:343
#define VARSIZE(PTR)
Definition: postgres.h:317
char * defnamespace
Definition: parsenodes.h:776
Node * arg
Definition: parsenodes.h:778

References accumArrayResult(), DefElem::arg, CurrentMemoryContext, DatumGetArrayTypeP, DatumGetPointer(), deconstruct_array_builtin(), defGetBoolean(), defGetString(), DefElem::defname, DefElem::defnamespace, ereport, errcode(), errmsg(), ERROR, i, len, lfirst, makeArrayResult(), NIL, palloc(), PointerGetDatum(), PointerIsValid, SET_VARSIZE, sprintf, value, VARDATA, VARHDRSZ, and VARSIZE.

Referenced by AlterTableSpaceOptions(), ATExecSetOptions(), ATExecSetRelOptions(), ComputeIndexAttrs(), create_ctas_internal(), CreateTableSpace(), DefineIndex(), DefineRelation(), and ProcessUtilitySlow().

◆ untransformRelOptions()

List* untransformRelOptions ( Datum  options)

Definition at line 1333 of file reloptions.c.

1334 {
1335  List *result = NIL;
1336  ArrayType *array;
1337  Datum *optiondatums;
1338  int noptions;
1339  int i;
1340 
1341  /* Nothing to do if no options */
1343  return result;
1344 
1345  array = DatumGetArrayTypeP(options);
1346 
1347  deconstruct_array_builtin(array, TEXTOID, &optiondatums, NULL, &noptions);
1348 
1349  for (i = 0; i < noptions; i++)
1350  {
1351  char *s;
1352  char *p;
1353  Node *val = NULL;
1354 
1355  s = TextDatumGetCString(optiondatums[i]);
1356  p = strchr(s, '=');
1357  if (p)
1358  {
1359  *p++ = '\0';
1360  val = (Node *) makeString(p);
1361  }
1362  result = lappend(result, makeDefElem(s, val, -1));
1363  }
1364 
1365  return result;
1366 }
#define TextDatumGetCString(d)
Definition: builtins.h:86
long val
Definition: informix.c:664
DefElem * makeDefElem(char *name, Node *arg, int location)
Definition: makefuncs.c:546
Definition: pg_list.h:52
Definition: nodes.h:118
String * makeString(char *str)
Definition: value.c:63

References DatumGetArrayTypeP, DatumGetPointer(), deconstruct_array_builtin(), i, lappend(), makeDefElem(), makeString(), NIL, noptions, PointerIsValid, TextDatumGetCString, and val.

Referenced by ATExecSetRelOptions(), dblink_fdw_validator(), file_fdw_validator(), generateClonedIndexStmt(), GetForeignColumnOptions(), GetForeignDataWrapperExtended(), GetForeignServerExtended(), GetForeignTable(), GetUserMapping(), postgres_fdw_validator(), postgresql_fdw_validator(), and transformGenericOptions().

◆ view_reloptions()

bytea* view_reloptions ( Datum  reloptions,
bool  validate 
)

Definition at line 1999 of file reloptions.c.

2000 {
2001  static const relopt_parse_elt tab[] = {
2002  {"security_barrier", RELOPT_TYPE_BOOL,
2003  offsetof(ViewOptions, security_barrier)},
2004  {"security_invoker", RELOPT_TYPE_BOOL,
2005  offsetof(ViewOptions, security_invoker)},
2006  {"check_option", RELOPT_TYPE_ENUM,
2007  offsetof(ViewOptions, check_option)}
2008  };
2009 
2010  return (bytea *) build_reloptions(reloptions, validate,
2012  sizeof(ViewOptions),
2013  tab, lengthof(tab));
2014 }

References build_reloptions(), lengthof, RELOPT_KIND_VIEW, RELOPT_TYPE_BOOL, and RELOPT_TYPE_ENUM.

Referenced by ATExecSetRelOptions(), DefineRelation(), and extractRelOptions().