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 *colliculocale, 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 57 of file pg_collation.h.

Function Documentation

CATALOG()

CATALOG	(	pg_collation	,
		3456	,
		CollationRelationId
	)

Definition at line 29 of file pg_collation.h.

{
    Oid         oid;            /* oid */
    NameData    collname;       /* collation name */
 
    /* OID of namespace containing this collation */
    Oid         collnamespace BKI_DEFAULT(pg_catalog) BKI_LOOKUP(pg_namespace);
 
    /* owner of collation */
    Oid         collowner BKI_DEFAULT(POSTGRES) BKI_LOOKUP(pg_authid);
    char        collprovider;   /* see constants below */
    bool        collisdeterministic BKI_DEFAULT(t);
    int32       collencoding;   /* encoding for this collation; -1 = "all" */
#ifdef CATALOG_VARLEN           /* variable-length fields start here */
    text        collcollate BKI_DEFAULT(_null_);    /* LC_COLLATE setting */
    text        collctype BKI_DEFAULT(_null_);  /* LC_CTYPE setting */
    text        colliculocale BKI_DEFAULT(_null_);  /* ICU locale ID */
    text        collversion BKI_DEFAULT(_null_);    /* provider-dependent
                                                     * version of collation
                                                     * data */
#endif
} FormData_pg_collation;

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 *	colliculocale,
		const char *	collversion,
		bool	if_not_exists,
		bool	quiet
	)

Definition at line 46 of file pg_collation.c.

{
    Relation    rel;
    TupleDesc   tupDesc;
    HeapTuple   tup;
    Datum       values[Natts_pg_collation];
    bool        nulls[Natts_pg_collation];
    NameData    name_name;
    Oid         oid;
    ObjectAddress myself,
                referenced;
 
    Assert(collname);
    Assert(collnamespace);
    Assert(collowner);
    Assert((collcollate && collctype) || colliculocale);
 
    /*
     * Make sure there is no existing collation of same name & encoding.
     *
     * This would be caught by the unique index anyway; we're just giving a
     * friendlier error message.  The unique index provides a backstop against
     * race conditions.
     */
    oid = GetSysCacheOid3(COLLNAMEENCNSP,
                          Anum_pg_collation_oid,
                          PointerGetDatum(collname),
                          Int32GetDatum(collencoding),
                          ObjectIdGetDatum(collnamespace));
    if (OidIsValid(oid))
    {
        if (quiet)
            return InvalidOid;
        else if (if_not_exists)
        {
            /*
             * If we are in an extension script, insist that the pre-existing
             * object be a member of the extension, to avoid security risks.
             */
            ObjectAddressSet(myself, CollationRelationId, oid);
            checkMembershipInCurrentExtension(&myself);
 
            /* OK to skip */
            ereport(NOTICE,
                    (errcode(ERRCODE_DUPLICATE_OBJECT),
                     collencoding == -1
                     ? errmsg("collation \"%s\" already exists, skipping",
                              collname)
                     : errmsg("collation \"%s\" for encoding \"%s\" already exists, skipping",
                              collname, pg_encoding_to_char(collencoding))));
            return InvalidOid;
        }
        else
            ereport(ERROR,
                    (errcode(ERRCODE_DUPLICATE_OBJECT),
                     collencoding == -1
                     ? errmsg("collation \"%s\" already exists",
                              collname)
                     : errmsg("collation \"%s\" for encoding \"%s\" already exists",
                              collname, pg_encoding_to_char(collencoding))));
    }
 
    /* open pg_collation; see below about the lock level */
    rel = table_open(CollationRelationId, ShareRowExclusiveLock);
 
    /*
     * Also forbid a specific-encoding collation shadowing an any-encoding
     * collation, or an any-encoding collation being shadowed (see
     * get_collation_name()).  This test is not backed up by the unique index,
     * so we take a ShareRowExclusiveLock earlier, to protect against
     * concurrent changes fooling this check.
     */
    if (collencoding == -1)
        oid = GetSysCacheOid3(COLLNAMEENCNSP,
                              Anum_pg_collation_oid,
                              PointerGetDatum(collname),
                              Int32GetDatum(GetDatabaseEncoding()),
                              ObjectIdGetDatum(collnamespace));
    else
        oid = GetSysCacheOid3(COLLNAMEENCNSP,
                              Anum_pg_collation_oid,
                              PointerGetDatum(collname),
                              Int32GetDatum(-1),
                              ObjectIdGetDatum(collnamespace));
    if (OidIsValid(oid))
    {
        if (quiet)
        {
            table_close(rel, NoLock);
            return InvalidOid;
        }
        else if (if_not_exists)
        {
            /*
             * If we are in an extension script, insist that the pre-existing
             * object be a member of the extension, to avoid security risks.
             */
            ObjectAddressSet(myself, CollationRelationId, oid);
            checkMembershipInCurrentExtension(&myself);
 
            /* OK to skip */
            table_close(rel, NoLock);
            ereport(NOTICE,
                    (errcode(ERRCODE_DUPLICATE_OBJECT),
                     errmsg("collation \"%s\" already exists, skipping",
                            collname)));
            return InvalidOid;
        }
        else
            ereport(ERROR,
                    (errcode(ERRCODE_DUPLICATE_OBJECT),
                     errmsg("collation \"%s\" already exists",
                            collname)));
    }
 
    tupDesc = RelationGetDescr(rel);
 
    /* form a tuple */
    memset(nulls, 0, sizeof(nulls));
 
    namestrcpy(&name_name, collname);
    oid = GetNewOidWithIndex(rel, CollationOidIndexId,
                             Anum_pg_collation_oid);
    values[Anum_pg_collation_oid - 1] = ObjectIdGetDatum(oid);
    values[Anum_pg_collation_collname - 1] = NameGetDatum(&name_name);
    values[Anum_pg_collation_collnamespace - 1] = ObjectIdGetDatum(collnamespace);
    values[Anum_pg_collation_collowner - 1] = ObjectIdGetDatum(collowner);
    values[Anum_pg_collation_collprovider - 1] = CharGetDatum(collprovider);
    values[Anum_pg_collation_collisdeterministic - 1] = BoolGetDatum(collisdeterministic);
    values[Anum_pg_collation_collencoding - 1] = Int32GetDatum(collencoding);
    if (collcollate)
        values[Anum_pg_collation_collcollate - 1] = CStringGetTextDatum(collcollate);
    else
        nulls[Anum_pg_collation_collcollate - 1] = true;
    if (collctype)
        values[Anum_pg_collation_collctype - 1] = CStringGetTextDatum(collctype);
    else
        nulls[Anum_pg_collation_collctype - 1] = true;
    if (colliculocale)
        values[Anum_pg_collation_colliculocale - 1] = CStringGetTextDatum(colliculocale);
    else
        nulls[Anum_pg_collation_colliculocale - 1] = true;
    if (collversion)
        values[Anum_pg_collation_collversion - 1] = CStringGetTextDatum(collversion);
    else
        nulls[Anum_pg_collation_collversion - 1] = true;
 
    tup = heap_form_tuple(tupDesc, values, nulls);
 
    /* insert a new tuple */
    CatalogTupleInsert(rel, tup);
    Assert(OidIsValid(oid));
 
    /* set up dependencies for the new collation */
    myself.classId = CollationRelationId;
    myself.objectId = oid;
    myself.objectSubId = 0;
 
    /* create dependency on namespace */
    referenced.classId = NamespaceRelationId;
    referenced.objectId = collnamespace;
    referenced.objectSubId = 0;
    recordDependencyOn(&myself, &referenced, DEPENDENCY_NORMAL);
 
    /* create dependency on owner */
    recordDependencyOnOwner(CollationRelationId, oid, collowner);
 
    /* dependency on extension */
    recordDependencyOnCurrentExtension(&myself, false);
 
    /* Post creation hook for new collation */
    InvokeObjectPostCreateHook(CollationRelationId, oid, 0);
 
    heap_freetuple(tup);
    table_close(rel, NoLock);
 
    return oid;
}

References Assert(), BoolGetDatum(), CatalogTupleInsert(), CharGetDatum(), checkMembershipInCurrentExtension(), ObjectAddress::classId, COLLNAMEENCNSP, CStringGetTextDatum, DEPENDENCY_NORMAL, ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg(), ERROR, GetDatabaseEncoding(), GetNewOidWithIndex(), GetSysCacheOid3, heap_form_tuple(), heap_freetuple(), Int32GetDatum(), InvalidOid, InvokeObjectPostCreateHook, NameGetDatum(), namestrcpy(), NoLock, NOTICE, ObjectAddressSet, ObjectAddress::objectId, ObjectIdGetDatum(), ObjectAddress::objectSubId, OidIsValid, pg_encoding_to_char(), PointerGetDatum(), recordDependencyOn(), recordDependencyOnCurrentExtension(), recordDependencyOnOwner(), RelationGetDescr, 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 50 of file pg_collation.h.