domains.c File Reference

#include "postgres.h"
#include "access/htup_details.h"
#include "catalog/pg_type.h"
#include "executor/executor.h"
#include "lib/stringinfo.h"
#include "utils/builtins.h"
#include "utils/expandeddatum.h"
#include "utils/lsyscache.h"
#include "utils/syscache.h"
#include "utils/typcache.h"

Include dependency graph for domains.c:

Go to the source code of this file.

Data Structures
struct	DomainIOData

Typedefs
typedef struct DomainIOData	DomainIOData

Functions
static bool	domain_check_internal (Datum value, bool isnull, Oid domainType, void **extra, MemoryContext mcxt, Node *escontext)
static DomainIOData *	domain_state_setup (Oid domainType, bool binary, MemoryContext mcxt)
static void	domain_check_input (Datum value, bool isnull, DomainIOData *my_extra, Node *escontext)
Datum	domain_in (PG_FUNCTION_ARGS)
Datum	domain_recv (PG_FUNCTION_ARGS)
void	domain_check (Datum value, bool isnull, Oid domainType, void **extra, MemoryContext mcxt)
bool	domain_check_safe (Datum value, bool isnull, Oid domainType, void **extra, MemoryContext mcxt, Node *escontext)
int	errdatatype (Oid datatypeOid)
int	errdomainconstraint (Oid datatypeOid, const char *conname)

Typedef Documentation

DomainIOData

typedef struct DomainIOData DomainIOData

Function Documentation

domain_check()

void domain_check	(	Datum	value,
		bool	isnull,
		Oid	domainType,
		void **	extra,
		MemoryContext	mcxt
	)

Definition at line 346 of file domains.c.

{
    (void) domain_check_internal(value, isnull, domainType, extra, mcxt,
                                 NULL);
}

References domain_check_internal(), and value.

Referenced by check_domain_for_new_field(), check_domain_for_new_tuple(), expanded_record_set_fields(), hstore_populate_record(), plperl_return_next_internal(), plperl_sv_to_datum(), plpgsql_exec_function(), pltcl_build_tuple_result(), and PLyObject_ToDomain().

domain_check_input()

static void domain_check_input ( Datum  value, bool  isnull, DomainIOData *  my_extra, Node *  escontext  )

static

Definition at line 138 of file domains.c.

{
    ExprContext *econtext = my_extra->econtext;
    ListCell   *l;
 
    /* Make sure we have up-to-date constraints */
    UpdateDomainConstraintRef(&my_extra->constraint_ref);
 
    foreach(l, my_extra->constraint_ref.constraints)
    {
        DomainConstraintState *con = (DomainConstraintState *) lfirst(l);
 
        switch (con->constrainttype)
        {
            case DOM_CONSTRAINT_NOTNULL:
                if (isnull)
                {
                    errsave(escontext,
                            (errcode(ERRCODE_NOT_NULL_VIOLATION),
                             errmsg("domain %s does not allow null values",
                                    format_type_be(my_extra->domain_type)),
                             errdatatype(my_extra->domain_type)));
                    goto fail;
                }
                break;
            case DOM_CONSTRAINT_CHECK:
                {
                    /* Make the econtext if we didn't already */
                    if (econtext == NULL)
                    {
                        MemoryContext oldcontext;
 
                        oldcontext = MemoryContextSwitchTo(my_extra->mcxt);
                        econtext = CreateStandaloneExprContext();
                        MemoryContextSwitchTo(oldcontext);
                        my_extra->econtext = econtext;
                    }
 
                    /*
                     * Set up value to be returned by CoerceToDomainValue
                     * nodes.  Unlike in the generic expression case, this
                     * econtext couldn't be shared with anything else, so no
                     * need to save and restore fields.  But we do need to
                     * protect the passed-in value against being changed by
                     * called functions.  (It couldn't be a R/W expanded
                     * object for most uses, but that seems possible for
                     * domain_check().)
                     */
                    econtext->domainValue_datum =
                        MakeExpandedObjectReadOnly(value, isnull,
                                                   my_extra->constraint_ref.tcache->typlen);
                    econtext->domainValue_isNull = isnull;
 
                    if (!ExecCheck(con->check_exprstate, econtext))
                    {
                        errsave(escontext,
                                (errcode(ERRCODE_CHECK_VIOLATION),
                                 errmsg("value for domain %s violates check constraint \"%s\"",
                                        format_type_be(my_extra->domain_type),
                                        con->name),
                                 errdomainconstraint(my_extra->domain_type,
                                                     con->name)));
                        goto fail;
                    }
                    break;
                }
            default:
                elog(ERROR, "unrecognized constraint type: %d",
                     (int) con->constrainttype);
                break;
        }
    }
 
    /*
     * Before exiting, call any shutdown callbacks and reset econtext's
     * per-tuple memory.  This avoids leaking non-memory resources, if
     * anything in the expression(s) has any.
     */
fail:
    if (econtext)
        ReScanExprContext(econtext);
}

References DomainConstraintState::check_exprstate, DomainIOData::constraint_ref, DomainConstraintRef::constraints, DomainConstraintState::constrainttype, CreateStandaloneExprContext(), DOM_CONSTRAINT_CHECK, DOM_CONSTRAINT_NOTNULL, DomainIOData::domain_type, ExprContext::domainValue_datum, ExprContext::domainValue_isNull, DomainIOData::econtext, elog, errcode(), errdatatype(), errdomainconstraint(), errmsg(), ERROR, errsave, ExecCheck(), format_type_be(), lfirst, MakeExpandedObjectReadOnly, DomainIOData::mcxt, MemoryContextSwitchTo(), DomainConstraintState::name, ReScanExprContext(), DomainConstraintRef::tcache, TypeCacheEntry::typlen, UpdateDomainConstraintRef(), and value.

Referenced by domain_check_internal(), domain_in(), and domain_recv().

domain_check_internal()

static bool domain_check_internal ( Datum  value, bool  isnull, Oid  domainType, void **  extra, MemoryContext  mcxt, Node *  escontext  )

static

Definition at line 371 of file domains.c.

{
    DomainIOData *my_extra = NULL;
 
    if (mcxt == NULL)
        mcxt = CurrentMemoryContext;
 
    /*
     * We arrange to look up the needed info just once per series of calls,
     * assuming the domain type doesn't change underneath us (which really
     * shouldn't happen, but cope if it does).
     */
    if (extra)
        my_extra = (DomainIOData *) *extra;
    if (my_extra == NULL || my_extra->domain_type != domainType)
    {
        my_extra = domain_state_setup(domainType, true, mcxt);
        if (extra)
            *extra = my_extra;
    }
 
    /*
     * Do the necessary checks to ensure it's a valid domain value.
     */
    domain_check_input(value, isnull, my_extra, escontext);
 
    return !SOFT_ERROR_OCCURRED(escontext);
}

References CurrentMemoryContext, domain_check_input(), domain_state_setup(), DomainIOData::domain_type, SOFT_ERROR_OCCURRED, and value.

Referenced by domain_check(), and domain_check_safe().

domain_check_safe()

bool domain_check_safe	(	Datum	value,
		bool	isnull,
		Oid	domainType,
		void **	extra,
		MemoryContext	mcxt,
		Node *	escontext
	)

Definition at line 355 of file domains.c.

{
    return domain_check_internal(value, isnull, domainType, extra, mcxt,
                                 escontext);
}

References domain_check_internal(), and value.

Referenced by ExecEvalJsonCoercion(), populate_composite(), populate_domain(), and populate_recordset_record().

domain_in()

Datum domain_in

(

PG_FUNCTION_ARGS

)

Definition at line 227 of file domains.c.

{
    char       *string;
    Oid         domainType;
    Node       *escontext = fcinfo->context;
    DomainIOData *my_extra;
    Datum       value;
 
    /*
     * Since domain_in is not strict, we have to check for null inputs. The
     * typioparam argument should never be null in normal system usage, but it
     * could be null in a manual invocation --- if so, just return null.
     */
    if (PG_ARGISNULL(0))
        string = NULL;
    else
        string = PG_GETARG_CSTRING(0);
    if (PG_ARGISNULL(1))
        PG_RETURN_NULL();
    domainType = PG_GETARG_OID(1);
 
    /*
     * We arrange to look up the needed info just once per series of calls,
     * assuming the domain type doesn't change underneath us (which really
     * shouldn't happen, but cope if it does).
     */
    my_extra = (DomainIOData *) fcinfo->flinfo->fn_extra;
    if (my_extra == NULL || my_extra->domain_type != domainType)
    {
        my_extra = domain_state_setup(domainType, false,
                                      fcinfo->flinfo->fn_mcxt);
        fcinfo->flinfo->fn_extra = my_extra;
    }
 
    /*
     * Invoke the base type's typinput procedure to convert the data.
     */
    if (!InputFunctionCallSafe(&my_extra->proc,
                               string,
                               my_extra->typioparam,
                               my_extra->typtypmod,
                               escontext,
                               &value))
        PG_RETURN_NULL();
 
    /*
     * Do the necessary checks to ensure it's a valid domain value.
     */
    domain_check_input(value, (string == NULL), my_extra, escontext);
 
    if (string == NULL)
        PG_RETURN_NULL();
    else
        PG_RETURN_DATUM(value);
}

References domain_check_input(), domain_state_setup(), DomainIOData::domain_type, if(), InputFunctionCallSafe(), PG_ARGISNULL, PG_GETARG_CSTRING, PG_GETARG_OID, PG_RETURN_DATUM, PG_RETURN_NULL, DomainIOData::proc, DomainIOData::typioparam, DomainIOData::typtypmod, and value.

domain_recv()

Datum domain_recv

(

PG_FUNCTION_ARGS

)

Definition at line 287 of file domains.c.

{
    StringInfo  buf;
    Oid         domainType;
    DomainIOData *my_extra;
    Datum       value;
 
    /*
     * Since domain_recv is not strict, we have to check for null inputs. The
     * typioparam argument should never be null in normal system usage, but it
     * could be null in a manual invocation --- if so, just return null.
     */
    if (PG_ARGISNULL(0))
        buf = NULL;
    else
        buf = (StringInfo) PG_GETARG_POINTER(0);
    if (PG_ARGISNULL(1))
        PG_RETURN_NULL();
    domainType = PG_GETARG_OID(1);
 
    /*
     * We arrange to look up the needed info just once per series of calls,
     * assuming the domain type doesn't change underneath us (which really
     * shouldn't happen, but cope if it does).
     */
    my_extra = (DomainIOData *) fcinfo->flinfo->fn_extra;
    if (my_extra == NULL || my_extra->domain_type != domainType)
    {
        my_extra = domain_state_setup(domainType, true,
                                      fcinfo->flinfo->fn_mcxt);
        fcinfo->flinfo->fn_extra = my_extra;
    }
 
    /*
     * Invoke the base type's typreceive procedure to convert the data.
     */
    value = ReceiveFunctionCall(&my_extra->proc,
                                buf,
                                my_extra->typioparam,
                                my_extra->typtypmod);
 
    /*
     * Do the necessary checks to ensure it's a valid domain value.
     */
    domain_check_input(value, (buf == NULL), my_extra, NULL);
 
    if (buf == NULL)
        PG_RETURN_NULL();
    else
        PG_RETURN_DATUM(value);
}

References buf, domain_check_input(), domain_state_setup(), DomainIOData::domain_type, if(), PG_ARGISNULL, PG_GETARG_OID, PG_GETARG_POINTER, PG_RETURN_DATUM, PG_RETURN_NULL, DomainIOData::proc, ReceiveFunctionCall(), DomainIOData::typioparam, DomainIOData::typtypmod, and value.

domain_state_setup()

static DomainIOData * domain_state_setup ( Oid  domainType, bool  binary, MemoryContext  mcxt  )

static

Definition at line 76 of file domains.c.

{
    DomainIOData *my_extra;
    TypeCacheEntry *typentry;
    Oid         baseType;
 
    my_extra = (DomainIOData *) MemoryContextAlloc(mcxt, sizeof(DomainIOData));
 
    /*
     * Verify that domainType represents a valid domain type.  We need to be
     * careful here because domain_in and domain_recv can be called from SQL,
     * possibly with incorrect arguments.  We use lookup_type_cache mainly
     * because it will throw a clean user-facing error for a bad OID; but also
     * it can cache the underlying base type info.
     */
    typentry = lookup_type_cache(domainType, TYPECACHE_DOMAIN_BASE_INFO);
    if (typentry->typtype != TYPTYPE_DOMAIN)
        ereport(ERROR,
                (errcode(ERRCODE_DATATYPE_MISMATCH),
                 errmsg("type %s is not a domain",
                        format_type_be(domainType))));
 
    /* Find out the base type */
    baseType = typentry->domainBaseType;
    my_extra->typtypmod = typentry->domainBaseTypmod;
 
    /* Look up underlying I/O function */
    if (binary)
        getTypeBinaryInputInfo(baseType,
                               &my_extra->typiofunc,
                               &my_extra->typioparam);
    else
        getTypeInputInfo(baseType,
                         &my_extra->typiofunc,
                         &my_extra->typioparam);
    fmgr_info_cxt(my_extra->typiofunc, &my_extra->proc, mcxt);
 
    /* Look up constraints for domain */
    InitDomainConstraintRef(domainType, &my_extra->constraint_ref, mcxt, true);
 
    /* We don't make an ExprContext until needed */
    my_extra->econtext = NULL;
    my_extra->mcxt = mcxt;
 
    /* Mark cache valid */
    my_extra->domain_type = domainType;
 
    return my_extra;
}

References DomainIOData::constraint_ref, DomainIOData::domain_type, TypeCacheEntry::domainBaseType, TypeCacheEntry::domainBaseTypmod, DomainIOData::econtext, ereport, errcode(), errmsg(), ERROR, fmgr_info_cxt(), format_type_be(), getTypeBinaryInputInfo(), getTypeInputInfo(), InitDomainConstraintRef(), lookup_type_cache(), DomainIOData::mcxt, MemoryContextAlloc(), DomainIOData::proc, TYPECACHE_DOMAIN_BASE_INFO, DomainIOData::typiofunc, DomainIOData::typioparam, TypeCacheEntry::typtype, and DomainIOData::typtypmod.

Referenced by domain_check_internal(), domain_in(), and domain_recv().

errdatatype()

int errdatatype

(

Oid

datatypeOid

)

Definition at line 407 of file domains.c.

{
    HeapTuple   tup;
    Form_pg_type typtup;
 
    tup = SearchSysCache1(TYPEOID, ObjectIdGetDatum(datatypeOid));
    if (!HeapTupleIsValid(tup))
        elog(ERROR, "cache lookup failed for type %u", datatypeOid);
    typtup = (Form_pg_type) GETSTRUCT(tup);
 
    err_generic_string(PG_DIAG_SCHEMA_NAME,
                       get_namespace_name(typtup->typnamespace));
    err_generic_string(PG_DIAG_DATATYPE_NAME, NameStr(typtup->typname));
 
    ReleaseSysCache(tup);
 
    return 0;                   /* return value does not matter */
}

References elog, err_generic_string(), ERROR, get_namespace_name(), GETSTRUCT(), HeapTupleIsValid, NameStr, ObjectIdGetDatum(), PG_DIAG_DATATYPE_NAME, PG_DIAG_SCHEMA_NAME, ReleaseSysCache(), and SearchSysCache1().

Referenced by domain_check_input(), errdomainconstraint(), and ExecEvalConstraintNotNull().

errdomainconstraint()

int errdomainconstraint	(	Oid	datatypeOid,
		const char *	conname
	)

Definition at line 431 of file domains.c.

{
    errdatatype(datatypeOid);
    err_generic_string(PG_DIAG_CONSTRAINT_NAME, conname);
 
    return 0;                   /* return value does not matter */
}

References err_generic_string(), errdatatype(), and PG_DIAG_CONSTRAINT_NAME.

Referenced by domain_check_input(), and ExecEvalConstraintCheck().