PostgreSQL Source Code  git master
Typedefs | Functions | Variables
pg_collation.h File Reference
#include "catalog/genbki.h"
#include "catalog/pg_collation_d.h"
Include dependency graph for pg_collation.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs

typedef FormData_pg_collation * Form_pg_collation
 

Functions

 CATALOG (pg_collation, 3456, CollationRelationId)
 
 DECLARE_TOAST (pg_collation, 6175, 6176)
 
 DECLARE_UNIQUE_INDEX (pg_collation_name_enc_nsp_index, 3164, CollationNameEncNspIndexId, on pg_collation using btree(collname name_ops, collencoding int4_ops, collnamespace oid_ops))
 
 DECLARE_UNIQUE_INDEX_PKEY (pg_collation_oid_index, 3085, CollationOidIndexId, on pg_collation using btree(oid oid_ops))
 
Oid CollationCreate (const char *collname, Oid collnamespace, Oid collowner, char collprovider, bool collisdeterministic, int32 collencoding, const char *collcollate, const char *collctype, const char *collversion, bool if_not_exists, bool quiet)
 

Variables

 FormData_pg_collation
 

Typedef Documentation

◆ Form_pg_collation

typedef FormData_pg_collation* Form_pg_collation

Definition at line 56 of file pg_collation.h.

Function Documentation

◆ CATALOG()

CATALOG ( pg_collation  ,
3456  ,
CollationRelationId   
)

Definition at line 29 of file pg_collation.h.

30 {
31  Oid oid; /* oid */
32  NameData collname; /* collation name */
33 
34  /* OID of namespace containing this collation */
35  Oid collnamespace BKI_DEFAULT(pg_catalog) BKI_LOOKUP(pg_namespace);
36 
37  /* owner of collation */
38  Oid collowner BKI_DEFAULT(POSTGRES) BKI_LOOKUP(pg_authid);
39  char collprovider; /* see constants below */
40  bool collisdeterministic BKI_DEFAULT(t);
41  int32 collencoding; /* encoding for this collation; -1 = "all" */
42  NameData collcollate; /* LC_COLLATE setting */
43  NameData collctype; /* LC_CTYPE setting */
44 #ifdef CATALOG_VARLEN /* variable-length fields start here */
45  text collversion BKI_DEFAULT(_null_); /* provider-dependent
46  * version of collation
47  * data */
48 #endif
49 } FormData_pg_collation;
int32
signed int int32
Definition: c.h:429
BKI_LOOKUP
#define BKI_LOOKUP(catalog)
Definition: genbki.h:46
BKI_DEFAULT
#define BKI_DEFAULT(value)
Definition: genbki.h:35
FormData_pg_collation
FormData_pg_collation
Definition: pg_collation.h:49
Oid
unsigned int Oid
Definition: postgres_ext.h:31
nameData
Definition: c.h:676
varlena
Definition: c.h:622

References BKI_DEFAULT, and BKI_LOOKUP.

◆ CollationCreate()

Oid CollationCreate ( const char *  collname,
Oid  collnamespace,
Oid  collowner,
char  collprovider,
bool  collisdeterministic,
int32  collencoding,
const char *  collcollate,
const char *  collctype,
const char *  collversion,
bool  if_not_exists,
bool  quiet 
)

Definition at line 46 of file pg_collation.c.

55 {
56  Relation rel;
57  TupleDesc tupDesc;
58  HeapTuple tup;
59  Datum values[Natts_pg_collation];
60  bool nulls[Natts_pg_collation];
61  NameData name_name,
62  name_collate,
63  name_ctype;
64  Oid oid;
65  ObjectAddress myself,
66  referenced;
67 
68  AssertArg(collname);
69  AssertArg(collnamespace);
70  AssertArg(collowner);
71  AssertArg(collcollate);
72  AssertArg(collctype);
73 
74  /*
75  * Make sure there is no existing collation of same name & encoding.
76  *
77  * This would be caught by the unique index anyway; we're just giving a
78  * friendlier error message. The unique index provides a backstop against
79  * race conditions.
80  */
81  if (SearchSysCacheExists3(COLLNAMEENCNSP,
82  PointerGetDatum(collname),
83  Int32GetDatum(collencoding),
84  ObjectIdGetDatum(collnamespace)))
85  {
86  if (quiet)
87  return InvalidOid;
88  else if (if_not_exists)
89  {
90  ereport(NOTICE,
91  (errcode(ERRCODE_DUPLICATE_OBJECT),
92  collencoding == -1
93  ? errmsg("collation \"%s\" already exists, skipping",
94  collname)
95  : errmsg("collation \"%s\" for encoding \"%s\" already exists, skipping",
96  collname, pg_encoding_to_char(collencoding))));
97  return InvalidOid;
98  }
99  else
100  ereport(ERROR,
101  (errcode(ERRCODE_DUPLICATE_OBJECT),
102  collencoding == -1
103  ? errmsg("collation \"%s\" already exists",
104  collname)
105  : errmsg("collation \"%s\" for encoding \"%s\" already exists",
106  collname, pg_encoding_to_char(collencoding))));
107  }
108 
109  /* open pg_collation; see below about the lock level */
110  rel = table_open(CollationRelationId, ShareRowExclusiveLock);
111 
112  /*
113  * Also forbid a specific-encoding collation shadowing an any-encoding
114  * collation, or an any-encoding collation being shadowed (see
115  * get_collation_name()). This test is not backed up by the unique index,
116  * so we take a ShareRowExclusiveLock earlier, to protect against
117  * concurrent changes fooling this check.
118  */
119  if ((collencoding == -1 &&
120  SearchSysCacheExists3(COLLNAMEENCNSP,
121  PointerGetDatum(collname),
122  Int32GetDatum(GetDatabaseEncoding()),
123  ObjectIdGetDatum(collnamespace))) ||
124  (collencoding != -1 &&
125  SearchSysCacheExists3(COLLNAMEENCNSP,
126  PointerGetDatum(collname),
127  Int32GetDatum(-1),
128  ObjectIdGetDatum(collnamespace))))
129  {
130  if (quiet)
131  {
132  table_close(rel, NoLock);
133  return InvalidOid;
134  }
135  else if (if_not_exists)
136  {
137  table_close(rel, NoLock);
138  ereport(NOTICE,
139  (errcode(ERRCODE_DUPLICATE_OBJECT),
140  errmsg("collation \"%s\" already exists, skipping",
141  collname)));
142  return InvalidOid;
143  }
144  else
145  ereport(ERROR,
146  (errcode(ERRCODE_DUPLICATE_OBJECT),
147  errmsg("collation \"%s\" already exists",
148  collname)));
149  }
150 
151  tupDesc = RelationGetDescr(rel);
152 
153  /* form a tuple */
154  memset(nulls, 0, sizeof(nulls));
155 
156  namestrcpy(&name_name, collname);
157  oid = GetNewOidWithIndex(rel, CollationOidIndexId,
158  Anum_pg_collation_oid);
159  values[Anum_pg_collation_oid - 1] = ObjectIdGetDatum(oid);
160  values[Anum_pg_collation_collname - 1] = NameGetDatum(&name_name);
161  values[Anum_pg_collation_collnamespace - 1] = ObjectIdGetDatum(collnamespace);
162  values[Anum_pg_collation_collowner - 1] = ObjectIdGetDatum(collowner);
163  values[Anum_pg_collation_collprovider - 1] = CharGetDatum(collprovider);
164  values[Anum_pg_collation_collisdeterministic - 1] = BoolGetDatum(collisdeterministic);
165  values[Anum_pg_collation_collencoding - 1] = Int32GetDatum(collencoding);
166  namestrcpy(&name_collate, collcollate);
167  values[Anum_pg_collation_collcollate - 1] = NameGetDatum(&name_collate);
168  namestrcpy(&name_ctype, collctype);
169  values[Anum_pg_collation_collctype - 1] = NameGetDatum(&name_ctype);
170  if (collversion)
171  values[Anum_pg_collation_collversion - 1] = CStringGetTextDatum(collversion);
172  else
173  nulls[Anum_pg_collation_collversion - 1] = true;
174 
175  tup = heap_form_tuple(tupDesc, values, nulls);
176 
177  /* insert a new tuple */
178  CatalogTupleInsert(rel, tup);
179  Assert(OidIsValid(oid));
180 
181  /* set up dependencies for the new collation */
182  myself.classId = CollationRelationId;
183  myself.objectId = oid;
184  myself.objectSubId = 0;
185 
186  /* create dependency on namespace */
187  referenced.classId = NamespaceRelationId;
188  referenced.objectId = collnamespace;
189  referenced.objectSubId = 0;
190  recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
191 
192  /* create dependency on owner */
193  recordDependencyOnOwner(CollationRelationId, oid, collowner);
194 
195  /* dependency on extension */
196  recordDependencyOnCurrentExtension(&myself, false);
197 
198  /* Post creation hook for new collation */
199  InvokeObjectPostCreateHook(CollationRelationId, oid, 0);
200 
201  heap_freetuple(tup);
202  table_close(rel, NoLock);
203 
204  return oid;
205 }
values
static Datum values[MAXATTR]
Definition: bootstrap.c:156
CStringGetTextDatum
#define CStringGetTextDatum(s)
Definition: builtins.h:86
OidIsValid
#define OidIsValid(objectId)
Definition: c.h:710
AssertArg
#define AssertArg(condition)
Definition: c.h:806
GetNewOidWithIndex
Oid GetNewOidWithIndex(Relation relation, Oid indexId, AttrNumber oidcolumn)
Definition: catalog.c:381
DEPENDENCY_NORMAL
@ DEPENDENCY_NORMAL
Definition: dependency.h:33
errcode
int errcode(int sqlerrcode)
Definition: elog.c:698
errmsg
int errmsg(const char *fmt,...)
Definition: elog.c:909
ERROR
#define ERROR
Definition: elog.h:33
NOTICE
#define NOTICE
Definition: elog.h:29
ereport
#define ereport(elevel,...)
Definition: elog.h:143
pg_encoding_to_char
const char * pg_encoding_to_char(int encoding)
Definition: encnames.c:588
heap_form_tuple
HeapTuple heap_form_tuple(TupleDesc tupleDescriptor, Datum *values, bool *isnull)
Definition: heaptuple.c:1020
heap_freetuple
void heap_freetuple(HeapTuple htup)
Definition: heaptuple.c:1338
CatalogTupleInsert
void CatalogTupleInsert(Relation heapRel, HeapTuple tup)
Definition: indexing.c:221
Assert
Assert(fmt[strlen(fmt) - 1] !='\n')
NoLock
#define NoLock
Definition: lockdefs.h:34
ShareRowExclusiveLock
#define ShareRowExclusiveLock
Definition: lockdefs.h:41
GetDatabaseEncoding
int GetDatabaseEncoding(void)
Definition: mbutils.c:1210
namestrcpy
void namestrcpy(Name name, const char *str)
Definition: name.c:233
InvokeObjectPostCreateHook
#define InvokeObjectPostCreateHook(classId, objectId, subId)
Definition: objectaccess.h:151
recordDependencyOn
void recordDependencyOn(const ObjectAddress *depender, const ObjectAddress *referenced, DependencyType behavior)
Definition: pg_depend.c:44
recordDependencyOnCurrentExtension
void recordDependencyOnCurrentExtension(const ObjectAddress *object, bool isReplace)
Definition: pg_depend.c:191
recordDependencyOnOwner
void recordDependencyOnOwner(Oid classId, Oid objectId, Oid owner)
Definition: pg_shdepend.c:163
Datum
uintptr_t Datum
Definition: postgres.h:411
ObjectIdGetDatum
#define ObjectIdGetDatum(X)
Definition: postgres.h:551
BoolGetDatum
#define BoolGetDatum(X)
Definition: postgres.h:446
Int32GetDatum
#define Int32GetDatum(X)
Definition: postgres.h:523
NameGetDatum
#define NameGetDatum(X)
Definition: postgres.h:639
CharGetDatum
#define CharGetDatum(X)
Definition: postgres.h:460
PointerGetDatum
#define PointerGetDatum(X)
Definition: postgres.h:600
InvalidOid
#define InvalidOid
Definition: postgres_ext.h:36
RelationGetDescr
#define RelationGetDescr(relation)
Definition: rel.h:503
ERRCODE_DUPLICATE_OBJECT
#define ERRCODE_DUPLICATE_OBJECT
Definition: streamutil.c:32
COLLNAMEENCNSP
@ COLLNAMEENCNSP
Definition: syscache.h:49
SearchSysCacheExists3
#define SearchSysCacheExists3(cacheId, key1, key2, key3)
Definition: syscache.h:190
table_close
void table_close(Relation relation, LOCKMODE lockmode)
Definition: table.c:167
table_open
Relation table_open(Oid relationId, LOCKMODE lockmode)
Definition: table.c:39

References Assert(), AssertArg, BoolGetDatum, CatalogTupleInsert(), CharGetDatum, ObjectAddress::classId, COLLNAMEENCNSP, CStringGetTextDatum, DEPENDENCY_NORMAL, ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg(), ERROR, GetDatabaseEncoding(), GetNewOidWithIndex(), heap_form_tuple(), heap_freetuple(), Int32GetDatum, InvalidOid, InvokeObjectPostCreateHook, NameGetDatum, namestrcpy(), NoLock, NOTICE, ObjectAddress::objectId, ObjectIdGetDatum, ObjectAddress::objectSubId, OidIsValid, pg_encoding_to_char(), PointerGetDatum, recordDependencyOn(), recordDependencyOnCurrentExtension(), recordDependencyOnOwner(), RelationGetDescr, SearchSysCacheExists3, ShareRowExclusiveLock, table_close(), table_open(), and values.

Referenced by DefineCollation(), and pg_import_system_collations().

◆ DECLARE_TOAST()

DECLARE_TOAST ( pg_collation  ,
6175  ,
6176   
)

◆ DECLARE_UNIQUE_INDEX()

DECLARE_UNIQUE_INDEX ( pg_collation_name_enc_nsp_index  ,
3164  ,
CollationNameEncNspIndexId  ,
on pg_collation using   btreecollname name_ops, collencoding int4_ops, collnamespace oid_ops 
)

◆ DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY ( pg_collation_oid_index  ,
3085  ,
CollationOidIndexId  ,
on pg_collation using   btreeoid oid_ops 
)

Variable Documentation

◆ FormData_pg_collation

FormData_pg_collation

Definition at line 49 of file pg_collation.h.