PostgreSQL Source Code  git master
Macros | 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.

Macros

#define CollationNameEncNspIndexId   3164
 
#define CollationOidIndexId   3085
 

Typedefs

typedef FormData_pg_collation * Form_pg_collation
 

Functions

 CATALOG (pg_collation, 3456, CollationRelationId)
 
 DECLARE_UNIQUE_INDEX (pg_collation_name_enc_nsp_index, 3164, on pg_collation using btree(collname name_ops, collencoding int4_ops, collnamespace oid_ops))
 
 DECLARE_UNIQUE_INDEX_PKEY (pg_collation_oid_index, 3085, 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, bool if_not_exists, bool quiet)
 

Variables

 FormData_pg_collation
 

Macro Definition Documentation

◆ CollationNameEncNspIndexId

#define CollationNameEncNspIndexId   3164

Definition at line 54 of file pg_collation.h.

◆ CollationOidIndexId

#define CollationOidIndexId   3085

Definition at line 56 of file pg_collation.h.

Referenced by CollationCreate().

Typedef Documentation

◆ Form_pg_collation

typedef FormData_pg_collation* Form_pg_collation

Definition at line 51 of file pg_collation.h.

Function Documentation

◆ CATALOG()

CATALOG ( pg_collation  ,
3456  ,
CollationRelationId   
)

Definition at line 29 of file pg_collation.h.

References BKI_DEFAULT, and BKI_LOOKUP.

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 } FormData_pg_collation;
Oid
unsigned int Oid
Definition: postgres_ext.h:31
BKI_DEFAULT
#define BKI_DEFAULT(value)
Definition: genbki.h:35
int32
signed int int32
Definition: c.h:429
nameData
Definition: c.h:675
BKI_LOOKUP
#define BKI_LOOKUP(catalog)
Definition: genbki.h:46
FormData_pg_collation
FormData_pg_collation
Definition: pg_collation.h:44

◆ CollationCreate()

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

Definition at line 46 of file pg_collation.c.

References Assert, AssertArg, BoolGetDatum, CatalogTupleInsert(), CharGetDatum, ObjectAddress::classId, CollationOidIndexId, COLLNAMEENCNSP, 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().

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

◆ DECLARE_UNIQUE_INDEX()

DECLARE_UNIQUE_INDEX ( pg_collation_name_enc_nsp_index  ,
3164  ,
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  ,
on pg_collation using   btreeoid oid_ops 
)

Variable Documentation

◆ FormData_pg_collation

FormData_pg_collation

Definition at line 44 of file pg_collation.h.