collationcmds.h File Reference

#include "catalog/objectaddress.h"
#include "parser/parse_node.h"

Include dependency graph for collationcmds.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
ObjectAddress	DefineCollation (ParseState *pstate, List *names, List *parameters, bool if_not_exists)
void	IsThereCollationInNamespace (const char *collname, Oid nspOid)
ObjectAddress	AlterCollation (AlterCollationStmt *stmt)

Function Documentation

AlterCollation()

ObjectAddress AlterCollation

(

AlterCollationStmt *

stmt

)

Definition at line 424 of file collationcmds.c.

{
    Relation    rel;
    Oid         collOid;
    HeapTuple   tup;
    Form_pg_collation collForm;
    Datum       datum;
    bool        isnull;
    char       *oldversion;
    char       *newversion;
    ObjectAddress address;
 
    rel = table_open(CollationRelationId, RowExclusiveLock);
    collOid = get_collation_oid(stmt->collname, false);
 
    if (collOid == DEFAULT_COLLATION_OID)
        ereport(ERROR,
                (errmsg("cannot refresh version of default collation"),
        /* translator: %s is an SQL command */
                 errhint("Use %s instead.",
                         "ALTER DATABASE ... REFRESH COLLATION VERSION")));
 
    if (!object_ownercheck(CollationRelationId, collOid, GetUserId()))
        aclcheck_error(ACLCHECK_NOT_OWNER, OBJECT_COLLATION,
                       NameListToString(stmt->collname));
 
    tup = SearchSysCacheCopy1(COLLOID, ObjectIdGetDatum(collOid));
    if (!HeapTupleIsValid(tup))
        elog(ERROR, "cache lookup failed for collation %u", collOid);
 
    collForm = (Form_pg_collation) GETSTRUCT(tup);
    datum = SysCacheGetAttr(COLLOID, tup, Anum_pg_collation_collversion, &isnull);
    oldversion = isnull ? NULL : TextDatumGetCString(datum);
 
    if (collForm->collprovider == COLLPROVIDER_LIBC)
        datum = SysCacheGetAttrNotNull(COLLOID, tup, Anum_pg_collation_collcollate);
    else
        datum = SysCacheGetAttrNotNull(COLLOID, tup, Anum_pg_collation_colllocale);
 
    newversion = get_collation_actual_version(collForm->collprovider,
                                              TextDatumGetCString(datum));
 
    /* cannot change from NULL to non-NULL or vice versa */
    if ((!oldversion && newversion) || (oldversion && !newversion))
        elog(ERROR, "invalid collation version change");
    else if (oldversion && newversion && strcmp(newversion, oldversion) != 0)
    {
        bool        nulls[Natts_pg_collation];
        bool        replaces[Natts_pg_collation];
        Datum       values[Natts_pg_collation];
 
        ereport(NOTICE,
                (errmsg("changing version from %s to %s",
                        oldversion, newversion)));
 
        memset(values, 0, sizeof(values));
        memset(nulls, false, sizeof(nulls));
        memset(replaces, false, sizeof(replaces));
 
        values[Anum_pg_collation_collversion - 1] = CStringGetTextDatum(newversion);
        replaces[Anum_pg_collation_collversion - 1] = true;
 
        tup = heap_modify_tuple(tup, RelationGetDescr(rel),
                                values, nulls, replaces);
    }
    else
        ereport(NOTICE,
                (errmsg("version has not changed")));
 
    CatalogTupleUpdate(rel, &tup->t_self, tup);
 
    InvokeObjectPostAlterHook(CollationRelationId, collOid, 0);
 
    ObjectAddressSet(address, CollationRelationId, collOid);
 
    heap_freetuple(tup);
    table_close(rel, NoLock);
 
    return address;
}

References aclcheck_error(), ACLCHECK_NOT_OWNER, CatalogTupleUpdate(), CStringGetTextDatum, elog, ereport, errhint(), errmsg(), ERROR, get_collation_actual_version(), get_collation_oid(), GETSTRUCT, GetUserId(), heap_freetuple(), heap_modify_tuple(), HeapTupleIsValid, InvokeObjectPostAlterHook, NameListToString(), NoLock, NOTICE, OBJECT_COLLATION, object_ownercheck(), ObjectAddressSet, ObjectIdGetDatum(), RelationGetDescr, RowExclusiveLock, SearchSysCacheCopy1, stmt, SysCacheGetAttr(), SysCacheGetAttrNotNull(), HeapTupleData::t_self, table_close(), table_open(), TextDatumGetCString, and values.

Referenced by ProcessUtilitySlow().

DefineCollation()

ObjectAddress DefineCollation	(	ParseState *	pstate,
		List *	names,
		List *	parameters,
		bool	if_not_exists
	)

Definition at line 53 of file collationcmds.c.

{
    char       *collName;
    Oid         collNamespace;
    AclResult   aclresult;
    ListCell   *pl;
    DefElem    *fromEl = NULL;
    DefElem    *localeEl = NULL;
    DefElem    *lccollateEl = NULL;
    DefElem    *lcctypeEl = NULL;
    DefElem    *providerEl = NULL;
    DefElem    *deterministicEl = NULL;
    DefElem    *rulesEl = NULL;
    DefElem    *versionEl = NULL;
    char       *collcollate;
    char       *collctype;
    const char *colllocale;
    char       *collicurules;
    bool        collisdeterministic;
    int         collencoding;
    char        collprovider;
    char       *collversion = NULL;
    Oid         newoid;
    ObjectAddress address;
 
    collNamespace = QualifiedNameGetCreationNamespace(names, &collName);
 
    aclresult = object_aclcheck(NamespaceRelationId, collNamespace, GetUserId(), ACL_CREATE);
    if (aclresult != ACLCHECK_OK)
        aclcheck_error(aclresult, OBJECT_SCHEMA,
                       get_namespace_name(collNamespace));
 
    foreach(pl, parameters)
    {
        DefElem    *defel = lfirst_node(DefElem, pl);
        DefElem   **defelp;
 
        if (strcmp(defel->defname, "from") == 0)
            defelp = &fromEl;
        else if (strcmp(defel->defname, "locale") == 0)
            defelp = &localeEl;
        else if (strcmp(defel->defname, "lc_collate") == 0)
            defelp = &lccollateEl;
        else if (strcmp(defel->defname, "lc_ctype") == 0)
            defelp = &lcctypeEl;
        else if (strcmp(defel->defname, "provider") == 0)
            defelp = &providerEl;
        else if (strcmp(defel->defname, "deterministic") == 0)
            defelp = &deterministicEl;
        else if (strcmp(defel->defname, "rules") == 0)
            defelp = &rulesEl;
        else if (strcmp(defel->defname, "version") == 0)
            defelp = &versionEl;
        else
        {
            ereport(ERROR,
                    (errcode(ERRCODE_SYNTAX_ERROR),
                     errmsg("collation attribute \"%s\" not recognized",
                            defel->defname),
                     parser_errposition(pstate, defel->location)));
            break;
        }
        if (*defelp != NULL)
            errorConflictingDefElem(defel, pstate);
        *defelp = defel;
    }
 
    if (localeEl && (lccollateEl || lcctypeEl))
        ereport(ERROR,
                errcode(ERRCODE_SYNTAX_ERROR),
                errmsg("conflicting or redundant options"),
                errdetail("LOCALE cannot be specified together with LC_COLLATE or LC_CTYPE."));
 
    if (fromEl && list_length(parameters) != 1)
        ereport(ERROR,
                errcode(ERRCODE_SYNTAX_ERROR),
                errmsg("conflicting or redundant options"),
                errdetail("FROM cannot be specified together with any other options."));
 
    if (fromEl)
    {
        Oid         collid;
        HeapTuple   tp;
        Datum       datum;
        bool        isnull;
 
        collid = get_collation_oid(defGetQualifiedName(fromEl), false);
        tp = SearchSysCache1(COLLOID, ObjectIdGetDatum(collid));
        if (!HeapTupleIsValid(tp))
            elog(ERROR, "cache lookup failed for collation %u", collid);
 
        collprovider = ((Form_pg_collation) GETSTRUCT(tp))->collprovider;
        collisdeterministic = ((Form_pg_collation) GETSTRUCT(tp))->collisdeterministic;
        collencoding = ((Form_pg_collation) GETSTRUCT(tp))->collencoding;
 
        datum = SysCacheGetAttr(COLLOID, tp, Anum_pg_collation_collcollate, &isnull);
        if (!isnull)
            collcollate = TextDatumGetCString(datum);
        else
            collcollate = NULL;
 
        datum = SysCacheGetAttr(COLLOID, tp, Anum_pg_collation_collctype, &isnull);
        if (!isnull)
            collctype = TextDatumGetCString(datum);
        else
            collctype = NULL;
 
        datum = SysCacheGetAttr(COLLOID, tp, Anum_pg_collation_colllocale, &isnull);
        if (!isnull)
            colllocale = TextDatumGetCString(datum);
        else
            colllocale = NULL;
 
        /*
         * When the ICU locale comes from an existing collation, do not
         * canonicalize to a language tag.
         */
 
        datum = SysCacheGetAttr(COLLOID, tp, Anum_pg_collation_collicurules, &isnull);
        if (!isnull)
            collicurules = TextDatumGetCString(datum);
        else
            collicurules = NULL;
 
        ReleaseSysCache(tp);
 
        /*
         * Copying the "default" collation is not allowed because most code
         * checks for DEFAULT_COLLATION_OID instead of COLLPROVIDER_DEFAULT,
         * and so having a second collation with COLLPROVIDER_DEFAULT would
         * not work and potentially confuse or crash some code.  This could be
         * fixed with some legwork.
         */
        if (collprovider == COLLPROVIDER_DEFAULT)
            ereport(ERROR,
                    (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
                     errmsg("collation \"default\" cannot be copied")));
    }
    else
    {
        char       *collproviderstr = NULL;
 
        collcollate = NULL;
        collctype = NULL;
        colllocale = NULL;
        collicurules = NULL;
 
        if (providerEl)
            collproviderstr = defGetString(providerEl);
 
        if (deterministicEl)
            collisdeterministic = defGetBoolean(deterministicEl);
        else
            collisdeterministic = true;
 
        if (rulesEl)
            collicurules = defGetString(rulesEl);
 
        if (versionEl)
            collversion = defGetString(versionEl);
 
        if (collproviderstr)
        {
            if (pg_strcasecmp(collproviderstr, "builtin") == 0)
                collprovider = COLLPROVIDER_BUILTIN;
            else if (pg_strcasecmp(collproviderstr, "icu") == 0)
                collprovider = COLLPROVIDER_ICU;
            else if (pg_strcasecmp(collproviderstr, "libc") == 0)
                collprovider = COLLPROVIDER_LIBC;
            else
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
                         errmsg("unrecognized collation provider: %s",
                                collproviderstr)));
        }
        else
            collprovider = COLLPROVIDER_LIBC;
 
        if (localeEl)
        {
            if (collprovider == COLLPROVIDER_LIBC)
            {
                collcollate = defGetString(localeEl);
                collctype = defGetString(localeEl);
            }
            else
                colllocale = defGetString(localeEl);
        }
 
        if (lccollateEl)
            collcollate = defGetString(lccollateEl);
 
        if (lcctypeEl)
            collctype = defGetString(lcctypeEl);
 
        if (collprovider == COLLPROVIDER_BUILTIN)
        {
            if (!colllocale)
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
                         errmsg("parameter \"%s\" must be specified",
                                "locale")));
 
            colllocale = builtin_validate_locale(GetDatabaseEncoding(),
                                                 colllocale);
        }
        else if (collprovider == COLLPROVIDER_LIBC)
        {
            if (!collcollate)
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
                         errmsg("parameter \"%s\" must be specified",
                                "lc_collate")));
 
            if (!collctype)
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
                         errmsg("parameter \"%s\" must be specified",
                                "lc_ctype")));
        }
        else if (collprovider == COLLPROVIDER_ICU)
        {
            if (!colllocale)
                ereport(ERROR,
                        (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
                         errmsg("parameter \"%s\" must be specified",
                                "locale")));
 
            /*
             * During binary upgrade, preserve the locale string. Otherwise,
             * canonicalize to a language tag.
             */
            if (!IsBinaryUpgrade)
            {
                char       *langtag = icu_language_tag(colllocale,
                                                       icu_validation_level);
 
                if (langtag && strcmp(colllocale, langtag) != 0)
                {
                    ereport(NOTICE,
                            (errmsg("using standard form \"%s\" for ICU locale \"%s\"",
                                    langtag, colllocale)));
 
                    colllocale = langtag;
                }
            }
 
            icu_validate_locale(colllocale);
        }
 
        /*
         * Nondeterministic collations are currently only supported with ICU
         * because that's the only case where it can actually make a
         * difference. So we can save writing the code for the other
         * providers.
         */
        if (!collisdeterministic && collprovider != COLLPROVIDER_ICU)
            ereport(ERROR,
                    (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                     errmsg("nondeterministic collations not supported with this provider")));
 
        if (collicurules && collprovider != COLLPROVIDER_ICU)
            ereport(ERROR,
                    (errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
                     errmsg("ICU rules cannot be specified unless locale provider is ICU")));
 
        if (collprovider == COLLPROVIDER_BUILTIN)
        {
            collencoding = builtin_locale_encoding(colllocale);
        }
        else if (collprovider == COLLPROVIDER_ICU)
        {
#ifdef USE_ICU
            /*
             * We could create ICU collations with collencoding == database
             * encoding, but it seems better to use -1 so that it matches the
             * way initdb would create ICU collations.  However, only allow
             * one to be created when the current database's encoding is
             * supported.  Otherwise the collation is useless, plus we get
             * surprising behaviors like not being able to drop the collation.
             *
             * Skip this test when !USE_ICU, because the error we want to
             * throw for that isn't thrown till later.
             */
            if (!is_encoding_supported_by_icu(GetDatabaseEncoding()))
                ereport(ERROR,
                        (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                         errmsg("current database's encoding is not supported with this provider")));
#endif
            collencoding = -1;
        }
        else
        {
            collencoding = GetDatabaseEncoding();
            check_encoding_locale_matches(collencoding, collcollate, collctype);
        }
    }
 
    if (!collversion)
    {
        const char *locale;
 
        if (collprovider == COLLPROVIDER_LIBC)
            locale = collcollate;
        else
            locale = colllocale;
 
        collversion = get_collation_actual_version(collprovider, locale);
    }
 
    newoid = CollationCreate(collName,
                             collNamespace,
                             GetUserId(),
                             collprovider,
                             collisdeterministic,
                             collencoding,
                             collcollate,
                             collctype,
                             colllocale,
                             collicurules,
                             collversion,
                             if_not_exists,
                             false);    /* not quiet */
 
    if (!OidIsValid(newoid))
        return InvalidObjectAddress;
 
    /* Check that the locales can be loaded. */
    CommandCounterIncrement();
    (void) pg_newlocale_from_collation(newoid);
 
    ObjectAddressSet(address, CollationRelationId, newoid);
 
    return address;
}

References ACL_CREATE, aclcheck_error(), ACLCHECK_OK, builtin_locale_encoding(), builtin_validate_locale(), check_encoding_locale_matches(), CollationCreate(), collid, CommandCounterIncrement(), defGetBoolean(), defGetQualifiedName(), defGetString(), DefElem::defname, elog, ereport, errcode(), errdetail(), errmsg(), ERROR, errorConflictingDefElem(), get_collation_actual_version(), get_collation_oid(), get_namespace_name(), GetDatabaseEncoding(), GETSTRUCT, GetUserId(), HeapTupleIsValid, icu_language_tag(), icu_validate_locale(), icu_validation_level, InvalidObjectAddress, is_encoding_supported_by_icu(), IsBinaryUpgrade, lfirst_node, list_length(), locale, DefElem::location, NOTICE, object_aclcheck(), OBJECT_SCHEMA, ObjectAddressSet, ObjectIdGetDatum(), OidIsValid, parser_errposition(), pg_newlocale_from_collation(), pg_strcasecmp(), QualifiedNameGetCreationNamespace(), ReleaseSysCache(), SearchSysCache1(), SysCacheGetAttr(), and TextDatumGetCString.

Referenced by ProcessUtilitySlow().

IsThereCollationInNamespace()

void IsThereCollationInNamespace	(	const char *	collname,
		Oid	nspOid
	)

Definition at line 396 of file collationcmds.c.

{
    /* make sure the name doesn't already exist in new schema */
    if (SearchSysCacheExists3(COLLNAMEENCNSP,
                              CStringGetDatum(collname),
                              Int32GetDatum(GetDatabaseEncoding()),
                              ObjectIdGetDatum(nspOid)))
        ereport(ERROR,
                (errcode(ERRCODE_DUPLICATE_OBJECT),
                 errmsg("collation \"%s\" for encoding \"%s\" already exists in schema \"%s\"",
                        collname, GetDatabaseEncodingName(),
                        get_namespace_name(nspOid))));
 
    /* mustn't match an any-encoding entry, either */
    if (SearchSysCacheExists3(COLLNAMEENCNSP,
                              CStringGetDatum(collname),
                              Int32GetDatum(-1),
                              ObjectIdGetDatum(nspOid)))
        ereport(ERROR,
                (errcode(ERRCODE_DUPLICATE_OBJECT),
                 errmsg("collation \"%s\" already exists in schema \"%s\"",
                        collname, get_namespace_name(nspOid))));
}

References CStringGetDatum(), ereport, errcode(), ERRCODE_DUPLICATE_OBJECT, errmsg(), ERROR, get_namespace_name(), GetDatabaseEncoding(), GetDatabaseEncodingName(), Int32GetDatum(), ObjectIdGetDatum(), and SearchSysCacheExists3.

Referenced by AlterObjectNamespace_internal(), and AlterObjectRename_internal().