Author: Marc Munro Copyright (c) 2005 - 20010 Marc Munro License: BSD $Id: veil_interface.c,v 1.14 2008/08/25 23:46:22 bloodnok Exp $
Definition in file veil_interface.c.
#include "postgres.h"
#include "executor/spi.h"
#include "funcapi.h"
#include "utils/hsearch.h"
#include "utils/memutils.h"
#include "veil_version.h"
#include "veil_funcs.h"
#include "veil_datatypes.h"
Go to the source code of this file.
Defines | |
#define | VEIL_SET_VARSIZE(new_t, t) SET_VARSIZE(new_t, t); |
Functions | |
const Pg_magic_struct * | Pg_magic_func (void) |
static char * | strfromtext (text *in) |
Create a dynamically allocated C string as a copy of a text value. | |
static text * | textfromstr (char *in) |
Create a dynamically allocated text value as a copy of a C string. | |
static text * | textfromstrn (char *in, int limit) |
Create a dynamically allocated text value as a copy of a C string, applying a limit to the length. | |
static char * | copystr (char *str) |
Create a dynamically allocated text value as a copy of a C string, applying a limit to the length. | |
static char * | strfromint (int4 val) |
Create a dynamically allocated C string as a copy of an integer value. | |
static char * | strfrombool (bool val) |
Create a dynamically allocated C string as a copy of a boolean value. | |
static void | ensure_init () |
Perform session initialisation once for the session. | |
void | vl_type_mismatch (char *name, ObjType expected, ObjType got) |
Report, by raising an error, a type mismatch between the expected and actual type of a VarEntry variable. | |
static Int4Var * | GetInt4Var (char *name, bool create) |
Return the Int4Var variable matching the name parameter, possibly creating the variable. | |
static Range * | GetRange (char *name, bool create) |
Return the Range variable matching the name parameter, possibly creating the variable. | |
static Bitmap * | GetBitmapFromVar (VarEntry *var, bool allow_empty, bool allow_ref) |
Return the Bitmap from a bitmap variable. | |
static Bitmap * | GetBitmap (char *name, bool allow_empty, bool allow_ref) |
Return the Bitmap matching the name parameter, possibly creating the VarEntry (variable) for it. | |
static BitmapRef * | GetBitmapRefFromVar (VarEntry *var) |
Return the BitmapRef from a bitmap ref variable. | |
static BitmapRef * | GetBitmapRef (char *name) |
Return the BitmapRef matching the name parameter, possibly creating the VarEntry (variable) for it. | |
static BitmapArray * | GetBitmapArrayFromVar (VarEntry *var, bool allow_empty) |
Return the BitmapArray from a bitmap array variable. | |
static BitmapArray * | GetBitmapArray (char *name, bool allow_empty) |
Return the BitmapArray matching the name parameter, possibly creating the (VarEntry) variable. | |
static BitmapHash * | GetBitmapHashFromVar (VarEntry *var, bool allow_empty) |
Return the BitmapHash from a bitmap hash variable. | |
static BitmapHash * | GetBitmapHash (char *name, bool allow_empty) |
Return the BitmapHash matching the name parameter, possibly creating the VarEntry (variable) for it. | |
static Int4Array * | GetInt4ArrayFromVar (VarEntry *var, bool allow_empty) |
Return the Int4Array from an Int4Array variable. | |
static Int4Array * | GetInt4Array (char *name, bool allow_empty) |
Return the Int4Array matching the name parameter, possibly creating the VarEntry (variable) for it. | |
const Pg_finfo_record * | pg_finfo_veil_share (void) |
Datum | veil_share (FunctionCallInfo fcinfo) |
veil_share(text) returns bool Define a shared variable returning true if the variable is already defined. | |
const Pg_finfo_record * | pg_finfo_veil_variables (void) |
Datum | veil_variables (FunctionCallInfo fcinfo) |
veil_variables() returns setof veil_variable_t Return a veil_variable_t record for each defined variable. | |
const Pg_finfo_record * | pg_finfo_veil_init_range (void) |
Datum | veil_init_range (FunctionCallInfo fcinfo) |
veil_init_range(text, int4, int4) returns int4 Initialise a Range variable, returning the number of elements in the range. | |
Datum | datum_from_range (int32 min, int32 max) |
Create a datum containing the values of a veil_range_t composite type. | |
const Pg_finfo_record * | pg_finfo_veil_range (void) |
Datum | veil_range (FunctionCallInfo fcinfo) |
veil_range(text) returns veil_range_t Return the range (as a SQL veil_range_t composite type) from the named variable. | |
const Pg_finfo_record * | pg_finfo_veil_init_bitmap (void) |
Datum | veil_init_bitmap (FunctionCallInfo fcinfo) |
veil_init_bitmap(text, text) returns bool Create or re-initialise a Bitmap, for dealing with a named range of values. | |
const Pg_finfo_record * | pg_finfo_veil_clear_bitmap (void) |
Datum | veil_clear_bitmap (FunctionCallInfo fcinfo) |
veil_clear_bitmap(text) returns bool Clear all bits in the specified Bitmap. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_setbit (void) |
Datum | veil_bitmap_setbit (FunctionCallInfo fcinfo) |
veil_bitmap_setbit(int4, text) returns bool Set the specified bit in the specified Bitmap. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_clearbit (void) |
Datum | veil_bitmap_clearbit (FunctionCallInfo fcinfo) |
veil_bitmap_clearbit(int4, text) returns bool Clear the specified bit in the specified Bitmap. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_testbit (void) |
Datum | veil_bitmap_testbit (FunctionCallInfo fcinfo) |
veil_bitmap_testbit(int4, text) returns bool Test the specified bit in the specified Bitmap, returning true if it is set. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_union (void) |
Datum | veil_bitmap_union (FunctionCallInfo fcinfo) |
veil_bitmap_union(text, text) returns bool Union the bitmap specified in parameter 1 with that in parameter 2, with the result in parameter 1. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_intersect (void) |
Datum | veil_bitmap_intersect (FunctionCallInfo fcinfo) |
veil_bitmap_intersect(text, text) returns bool Intersect the bitmap specified in parameter 1 with that in parameter 2, with the result in parameter 1. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_bits (void) |
Datum | veil_bitmap_bits (FunctionCallInfo fcinfo) |
veil_bitmap_bits(text) returns setof int4 Return the set of all bits set in the specified Bitmap or BitmapRef. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_range (void) |
Datum | veil_bitmap_range (FunctionCallInfo fcinfo) |
veil_bitmap_range(text) returns veil_range_t Return composite type giving the range of the specified Bitmap or BitmapRef. | |
const Pg_finfo_record * | pg_finfo_veil_init_bitmap_array (void) |
Datum | veil_init_bitmap_array (FunctionCallInfo fcinfo) |
veil_init_bitmap_array(text, text, text) returns bool Create or reset a BitmapArray. | |
const Pg_finfo_record * | pg_finfo_veil_clear_bitmap_array (void) |
Datum | veil_clear_bitmap_array (FunctionCallInfo fcinfo) |
veil_clear_bitmap_array(text) returns bool Clear the bits in an existing BitmapArray. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_from_array (void) |
Datum | veil_bitmap_from_array (FunctionCallInfo fcinfo) |
veil_bitmap_from_array(text, text, int4) returns text Place a reference to the specified Bitmap from a BitmapArray into the specified BitmapRef An error will be raised if any parameter is not of the correct type. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_array_testbit (void) |
Datum | veil_bitmap_array_testbit (FunctionCallInfo fcinfo) |
veil_bitmap_array_testbit(text, int4, int4) returns bool Test a specified bit within a BitmapArray | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_array_setbit (void) |
Datum | veil_bitmap_array_setbit (FunctionCallInfo fcinfo) |
veil_bitmap_array_setbit(text, int4, int4) returns bool Set a specified bit within a BitmapArray | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_array_clearbit (void) |
Datum | veil_bitmap_array_clearbit (FunctionCallInfo fcinfo) |
veil_bitmap_array_clearbit(text, int4, int4) returns bool Clear a specified bit within a BitmapArray | |
const Pg_finfo_record * | pg_finfo_veil_union_from_bitmap_array (void) |
Datum | veil_union_from_bitmap_array (FunctionCallInfo fcinfo) |
veil_union_from_bitmap_array(text, text, int4) returns bool Union a Bitmap with the specified Bitmap from a BitmapArray with the result placed into the first parameter. | |
const Pg_finfo_record * | pg_finfo_veil_intersect_from_bitmap_array (void) |
Datum | veil_intersect_from_bitmap_array (FunctionCallInfo fcinfo) |
veil_intersect_from_bitmap_array(text, text, int4) returns bool Intersect a Bitmap with the specified Bitmap from a BitmapArray with the result placed into the first parameter. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_array_bits (void) |
Datum | veil_bitmap_array_bits (FunctionCallInfo fcinfo) |
veil_bitmap_array_bits(text) returns setof int4 Return the set of all bits set in the specified Bitmap from the BitmapArray. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_array_arange (void) |
Datum | veil_bitmap_array_arange (FunctionCallInfo fcinfo) |
veil_bitmap_array_arange(text) returns veil_range_t Return composite type giving the range of the array part of the specified BitmapArray | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_array_brange (void) |
Datum | veil_bitmap_array_brange (FunctionCallInfo fcinfo) |
veil_bitmap_array_brange(text) returns veil_range_t Return composite type giving the range of every Bitmap within the BitmapArray. | |
const Pg_finfo_record * | pg_finfo_veil_init_bitmap_hash (void) |
Datum | veil_init_bitmap_hash (FunctionCallInfo fcinfo) |
veil_init_bitmap_hash(text, text) returns bool Create or reset a BitmapHash. | |
const Pg_finfo_record * | pg_finfo_veil_clear_bitmap_hash (void) |
Datum | veil_clear_bitmap_hash (FunctionCallInfo fcinfo) |
veil_clear_bitmap_hash(text) returns bool Clear the bits in an existing BitmapHash. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_hash_key_exists (void) |
Datum | veil_bitmap_hash_key_exists (FunctionCallInfo fcinfo) |
veil_bitmap_hashkey_exists(text, text) returns text Place a reference to the specified Bitmap from a BitmapHash into the specified BitmapRef An error will be raised if any parameter is not of the correct type. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_from_hash (void) |
Datum | veil_bitmap_from_hash (FunctionCallInfo fcinfo) |
veil_bitmap_from_hash(text, text, text) returns text Place a reference to the specified Bitmap from a BitmapHash into the specified BitmapRef An error will be raised if any parameter is not of the correct type. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_hash_testbit (void) |
Datum | veil_bitmap_hash_testbit (FunctionCallInfo fcinfo) |
veil_bitmap_hash_testbit(text, text, int4) returns bool Test a specified bit within a BitmapHash | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_hash_setbit (void) |
Datum | veil_bitmap_hash_setbit (FunctionCallInfo fcinfo) |
veil_bitmap_hash_setbit(text, text, int4) returns bool Set a specified bit within a BitmapHash | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_hash_clearbit (void) |
Datum | veil_bitmap_hash_clearbit (FunctionCallInfo fcinfo) |
veil_bitmap_hash_clearbit(text, text, int4) returns bool Clear a specified bit within a BitmapHash | |
const Pg_finfo_record * | pg_finfo_veil_union_into_bitmap_hash (void) |
Datum | veil_union_into_bitmap_hash (FunctionCallInfo fcinfo) |
veil_union_into_bitmap_hash(text, text, text) returns bool Union a Bitmap with the specified Bitmap from a BitmapHash with the result placed into the bitmap hash. | |
const Pg_finfo_record * | pg_finfo_veil_union_from_bitmap_hash (void) |
Datum | veil_union_from_bitmap_hash (FunctionCallInfo fcinfo) |
veil_union_from_bitmap_hash(text, text, text) returns bool Union a Bitmap with the specified Bitmap from a BitmapHash with the result placed into the bitmap parameter. | |
const Pg_finfo_record * | pg_finfo_veil_intersect_from_bitmap_hash (void) |
Datum | veil_intersect_from_bitmap_hash (FunctionCallInfo fcinfo) |
veil_intersect_from_bitmap_hash(text, text, text) returns bool Intersect a Bitmap with the specified Bitmap from a BitmapArray with the result placed into the bitmap parameter. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_hash_bits (void) |
Datum | veil_bitmap_hash_bits (FunctionCallInfo fcinfo) |
veil_bitmap_hash_bits(text) returns setof int4 Return the set of all bits set in the specified Bitmap from the BitmapHash. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_hash_range (void) |
Datum | veil_bitmap_hash_range (FunctionCallInfo fcinfo) |
veil_bitmap_hash_range(text) returns veil_range_t Return composite type giving the range of every Bitmap within the BitmapHash. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_hash_entries (void) |
Datum | veil_bitmap_hash_entries (FunctionCallInfo fcinfo) |
veil_bitmap_hash_entries(text) returns setof text Return the key of every Bitmap within the BitmapHash. | |
const Pg_finfo_record * | pg_finfo_veil_bitmap_hash_defined (void) |
Datum | veil_bitmap_hash_defined (FunctionCallInfo fcinfo) |
veil_bitmap_hash_defined(text, text) returns bool Return true if the key exists in the bitmap hash. | |
const Pg_finfo_record * | pg_finfo_veil_int4_set (void) |
Datum | veil_int4_set (FunctionCallInfo fcinfo) |
veil_int4_set(text, int4) returns int4 Set an Int4Var variable type to a specified value. | |
const Pg_finfo_record * | pg_finfo_veil_int4_get (void) |
Datum | veil_int4_get (FunctionCallInfo fcinfo) |
veil_int4_get(text) returns int4 Return the value of an Int4Var variable. | |
const Pg_finfo_record * | pg_finfo_veil_init_int4array (void) |
Datum | veil_init_int4array (FunctionCallInfo fcinfo) |
veil_init_int4array(text, text) returns bool Initialise an Int4Array variable. | |
const Pg_finfo_record * | pg_finfo_veil_clear_int4array (void) |
Datum | veil_clear_int4array (FunctionCallInfo fcinfo) |
veil_clear_int4array(text) returns bool Clear an Int4Array variable. | |
const Pg_finfo_record * | pg_finfo_veil_int4array_set (void) |
Datum | veil_int4array_set (FunctionCallInfo fcinfo) |
veil_int4array_set(text, int4, int4) returns int4 Set an Int4Array entry. | |
const Pg_finfo_record * | pg_finfo_veil_int4array_get (void) |
Datum | veil_int4array_get (FunctionCallInfo fcinfo) |
veil_int4array_get(text, int4) returns int4 Get an Int4Array entry. | |
const Pg_finfo_record * | pg_finfo_veil_init (void) |
Datum | veil_init (FunctionCallInfo fcinfo) |
veil_init(bool) returns bool Initialise or reset a veil session. | |
const Pg_finfo_record * | pg_finfo_veil_perform_reset (void) |
Datum | veil_perform_reset (FunctionCallInfo fcinfo) |
veil_perform_reset() returns bool Reset veil shared memory for this database. | |
const Pg_finfo_record * | pg_finfo_veil_force_reset (void) |
Datum | veil_force_reset (FunctionCallInfo fcinfo) |
veil_force_reset() returns bool Reset veil shared memory for this database, ignoring existing transactions. | |
const Pg_finfo_record * | pg_finfo_veil_version (void) |
Datum | veil_version (FunctionCallInfo fcinfo) |
veil_version() returns text Return a string describing this version of veil. | |
const Pg_finfo_record * | pg_finfo_veil_serialise (void) |
Datum | veil_serialise (FunctionCallInfo fcinfo) |
veil_serialise(text) returns text Return a string describing this version of veil. | |
const Pg_finfo_record * | pg_finfo_veil_deserialise (void) |
Datum | veil_deserialise (FunctionCallInfo fcinfo) |
veil_deserialise(text) returns text Create or reset variables based on the output of previous veil_serialise calls. | |
Variables | |
int | no_such_variable |
static char* strfromtext | ( | text * | in | ) | [static] |
Create a dynamically allocated C string as a copy of a text value.
in | text value from which the copy is made. |
Definition at line 51 of file veil_interface.c.
Referenced by veil_bitmap_array_bits(), veil_bitmap_bits(), veil_bitmap_hash_bits(), veil_clear_int4array(), and veil_serialise().
static text* textfromstr | ( | char * | in | ) | [static] |
Create a dynamically allocated text value as a copy of a C string.
in | String to be copied |
Definition at line 67 of file veil_interface.c.
static text* textfromstrn | ( | char * | in, | |
int | limit | |||
) | [static] |
Create a dynamically allocated text value as a copy of a C string, applying a limit to the length.
in | String to be copied | |
limit | Maximum length of string to be copied. |
Definition at line 86 of file veil_interface.c.
static char* copystr | ( | char * | str | ) | [static] |
Create a dynamically allocated text value as a copy of a C string, applying a limit to the length.
str | String to be copied |
Definition at line 110 of file veil_interface.c.
static char* strfromint | ( | int4 | val | ) | [static] |
Create a dynamically allocated C string as a copy of an integer value.
val | value to be stringified |
Definition at line 124 of file veil_interface.c.
static char* strfrombool | ( | bool | val | ) | [static] |
Create a dynamically allocated C string as a copy of a boolean value.
val | value to be stringified |
Definition at line 139 of file veil_interface.c.
static void ensure_init | ( | ) | [static] |
Perform session initialisation once for the session.
This calls the user-defined function veil_init which should create and possibly initialise all session and, maybe, shared variables. This function may be safely called any number of times - it will only perform the initialisation on the first call.
Definition at line 160 of file veil_interface.c.
References vl_bool_from_query(), and vl_get_shared_hash().
Referenced by veil_bitmap_array_bits(), veil_bitmap_bits(), veil_bitmap_hash_bits(), veil_clear_int4array(), veil_init(), veil_serialise(), and veil_variables().
Report, by raising an error, a type mismatch between the expected and actual type of a VarEntry variable.
name | The name of the variable | |
expected | The expected type. | |
got | The actual type |
Definition at line 217 of file veil_interface.c.
References vl_ObjTypeName().
Referenced by GetBitmapArrayFromVar(), GetBitmapFromVar(), GetBitmapHashFromVar(), GetBitmapRefFromVar(), and GetInt4ArrayFromVar().
static Int4Var* GetInt4Var | ( | char * | name, | |
bool | create | |||
) | [static] |
Return the Int4Var variable matching the name parameter, possibly creating the variable.
Raise an error if the named variable already exists and is of the wrong type.
name | The name of the variable. | |
create | Whether to create the variable if it does not exist. |
Definition at line 240 of file veil_interface.c.
static Range* GetRange | ( | char * | name, | |
bool | create | |||
) | [static] |
Return the Range variable matching the name parameter, possibly creating the variable.
Raise an error if the named variable already exists and is of the wrong type.
name | The name of the variable. | |
create | Whether to create the variable if it does not exist. |
Definition at line 277 of file veil_interface.c.
Return the Bitmap from a bitmap variable.
This function exists primarily to perform type checking, and to raise an error if the variable is not a bitmap.
var | The VarEntry that should contain a bitmap. | |
allow_empty | Whether to raise an error if the variable has not yet been initialised. | |
allow_ref | Whether to (not) raise an error if the variable is a bitmap_ref rather than a bitmap. |
Definition at line 317 of file veil_interface.c.
References BitmapRef::bitmap, VarEntry::key, Bitmap::type, vl_type_mismatch(), and BitmapRef::xid.
static Bitmap* GetBitmap | ( | char * | name, | |
bool | allow_empty, | |||
bool | allow_ref | |||
) | [static] |
Return the Bitmap matching the name parameter, possibly creating the VarEntry (variable) for it.
Raise an error if the named variable already exists and is of the wrong type.
name | The name of the variable. | |
allow_empty | Whether to raise an error if the variable has not been defined. | |
allow_ref | Whether to (not) raise an error if the variable is a bitmap_ref rather than a bitmap. |
Definition at line 368 of file veil_interface.c.
Referenced by veil_bitmap_bits().
Return the BitmapRef from a bitmap ref variable.
This function exists primarily to perform type checking, and to raise an error if the variable is not a bitmap ref. Note that BitmapRef variables may not be shared as they can contain references to non-shared objects.
var | The VarEntry that should contain a bitmap ref. |
Definition at line 391 of file veil_interface.c.
References VarEntry::key, BitmapRef::type, and vl_type_mismatch().
static BitmapRef* GetBitmapRef | ( | char * | name | ) | [static] |
Return the BitmapRef matching the name parameter, possibly creating the VarEntry (variable) for it.
Raise an error if the named variable already exists and is of the wrong type.
name | The name of the variable. |
Definition at line 429 of file veil_interface.c.
static BitmapArray* GetBitmapArrayFromVar | ( | VarEntry * | var, | |
bool | allow_empty | |||
) | [static] |
Return the BitmapArray from a bitmap array variable.
This function exists primarily to perform type checking, and to raise an error if the variable is not a bitmap array.
var | The VarEntry that should contain a bitmap array. | |
allow_empty | Whether to raise an error if the variable has not yet been initialised. |
Definition at line 452 of file veil_interface.c.
References VarEntry::key, BitmapArray::type, and vl_type_mismatch().
static BitmapArray* GetBitmapArray | ( | char * | name, | |
bool | allow_empty | |||
) | [static] |
Return the BitmapArray matching the name parameter, possibly creating the (VarEntry) variable.
Raise an error if the named variable already exists and is of the wrong type.
name | The name of the variable. | |
allow_empty | Whether to raise an error if the variable has not been defined |
Definition at line 484 of file veil_interface.c.
Referenced by veil_bitmap_array_bits().
static BitmapHash* GetBitmapHashFromVar | ( | VarEntry * | var, | |
bool | allow_empty | |||
) | [static] |
Return the BitmapHash from a bitmap hash variable.
This function exists primarily to perform type checking, and to raise an error if the variable is not a bitmap hash.
var | The VarEntry that should contain a bitmap hash. | |
allow_empty | Whether to raise an error if the variable has not yet been initialised. |
Definition at line 508 of file veil_interface.c.
References VarEntry::key, BitmapHash::type, and vl_type_mismatch().
static BitmapHash* GetBitmapHash | ( | char * | name, | |
bool | allow_empty | |||
) | [static] |
Return the BitmapHash matching the name parameter, possibly creating the VarEntry (variable) for it.
Raise an error if the named variable already exists and is of the wrong type.
name | The name of the variable. | |
allow_empty | Whether to raise an error if the variable has not been defined. |
Definition at line 540 of file veil_interface.c.
Referenced by veil_bitmap_hash_bits().
Return the Int4Array from an Int4Array variable.
This function exists primarily to perform type checking, and to raise an error if the variable is not an Int4Array.
var | The VarEntry that should contain an Int4Array. | |
allow_empty | Whether to raise an error if the variable has not yet been initialised. |
Definition at line 564 of file veil_interface.c.
References VarEntry::key, Int4Array::type, and vl_type_mismatch().
static Int4Array* GetInt4Array | ( | char * | name, | |
bool | allow_empty | |||
) | [static] |
Return the Int4Array matching the name parameter, possibly creating the VarEntry (variable) for it.
Raise an error if the named variable already exists and is of the wrong type.
name | The name of the variable. | |
allow_empty | Whether to raise an error if the variable has not been defined. |
Definition at line 596 of file veil_interface.c.
Referenced by veil_clear_int4array().
Datum veil_share | ( | FunctionCallInfo | fcinfo | ) |
veil_share(text) returns bool
Define a shared variable returning true if the variable is already defined.
If the variable is already defined as a session variable an ERROR will be raised.
Session variables are simply defined by their first usage. Shared variables must be defined using this function. They may then be used in exactly the same way as session variables. Shared variables are shared by all backends and so need only be initialised once. The result of this function tells the caller whether the variable needs to be initialised. The caller that first defines a shared variable will get a false result and from this will know that the variable must be initialised. All subsequent callers will get a true result and so will know that the variable is already initialised.
fcinfo | text name of variable. |
bool
true if the variable already exists Definition at line 629 of file veil_interface.c.
Datum veil_variables | ( | FunctionCallInfo | fcinfo | ) |
veil_variables() returns setof veil_variable_t
Return a veil_variable_t
record for each defined variable.
This includes both session and shared variables.
fcinfo | None |
setof veil_variable_t
Definition at line 652 of file veil_interface.c.
References ensure_init().
Datum veil_init_range | ( | FunctionCallInfo | fcinfo | ) |
veil_init_range(text, int4, int4) returns int4 Initialise a Range variable, returning the number of elements in the range.
Ranges contain a min value and a max value. They may be examined using the veil_range() function.
fcinfo | text The name of the variable to initialise. int4 The min value of the range. int4 The max value of the range. |
int4
The size of the range ((max - min) + 1). Definition at line 721 of file veil_interface.c.
Datum datum_from_range | ( | int32 | min, | |
int32 | max | |||
) |
Create a datum containing the values of a veil_range_t composite type.
min | Min value of range | |
max | Max value of range |
Definition at line 750 of file veil_interface.c.
Datum veil_range | ( | FunctionCallInfo | fcinfo | ) |
veil_range(text) returns veil_range_t
Return the range (as a SQL veil_range_t composite type) from the named variable.
An Error will be raised if the variable is not defined or is of the wrong type.
fcinfo | text The name of the range variable. |
veil_range_t
Composite type containing the min and max values from the named variable. Definition at line 798 of file veil_interface.c.
Datum veil_init_bitmap | ( | FunctionCallInfo | fcinfo | ) |
veil_init_bitmap(text, text) returns bool
Create or re-initialise a Bitmap, for dealing with a named range of values.
An error will be raised if the variable already exists and is not a Bitmap.
fcinfo | text The name of the bitmap to create or reset text The name of a Range variable that defines the range of the new bitmap. |
bool
true Definition at line 829 of file veil_interface.c.
Datum veil_clear_bitmap | ( | FunctionCallInfo | fcinfo | ) |
veil_clear_bitmap(text) returns bool
Clear all bits in the specified Bitmap.
An error will be raised if the variable is not a Bitmap or BitmapRef.
fcinfo | text The name of the bitmap to be cleared. |
bool
true Definition at line 863 of file veil_interface.c.
Datum veil_bitmap_setbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_setbit(int4, text) returns bool
Set the specified bit in the specified Bitmap.
An error will be raised if the variable is not a Bitmap or BitmapRef.
fcinfo | int4 The bit to be set text The name of the bitmap variable. |
bool
true Definition at line 892 of file veil_interface.c.
Datum veil_bitmap_clearbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_clearbit(int4, text) returns bool
Clear the specified bit in the specified Bitmap.
An error will be raised if the variable is not a Bitmap or BitmapRef.
fcinfo | int4 The bit to be cleared text The name of the bitmap variable. |
bool
true Definition at line 920 of file veil_interface.c.
Datum veil_bitmap_testbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_testbit(int4, text) returns bool
Test the specified bit in the specified Bitmap, returning true if it is set.
An error will be raised if the variable is not a Bitmap or BitmapRef.
fcinfo | int4 The bit to be tested. text The name of the bitmap variable. |
bool
true if the bit was set Definition at line 949 of file veil_interface.c.
Datum veil_bitmap_union | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_union(text, text) returns bool
Union the bitmap specified in parameter 1 with that in parameter 2, with the result in parameter 1.
An error will be raised if the variables are not of type Bitmap or BitmapRef.
fcinfo | text The target bitmap text The bitmap with which to union the target |
bool
true Definition at line 981 of file veil_interface.c.
Datum veil_bitmap_intersect | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_intersect(text, text) returns bool
Intersect the bitmap specified in parameter 1 with that in parameter 2, with the result in parameter 1.
An error will be raised if the variables are not of type Bitmap or BitmapRef.
fcinfo | text The target bitmap text The bitmap with which to intersect the target |
bool
true Definition at line 1015 of file veil_interface.c.
Datum veil_bitmap_bits | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_bits(text)
returns setof int4 Return the set of all bits set in the specified Bitmap or BitmapRef.
fcinfo | text The name of the bitmap. |
setof int4
The set of bits that are set in the bitmap. Definition at line 1044 of file veil_interface.c.
References ensure_init(), GetBitmap(), and strfromtext().
Datum veil_bitmap_range | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_range(text) returns veil_range_t
Return composite type giving the range of the specified Bitmap or BitmapRef.
fcinfo | text The name of the bitmap. |
veil_range_t
Composite type containing the min and max values of the bitmap's range Definition at line 1110 of file veil_interface.c.
Datum veil_init_bitmap_array | ( | FunctionCallInfo | fcinfo | ) |
veil_init_bitmap_array(text, text, text) returns bool
Create or reset a BitmapArray.
An error will be raised if any parameter is not of the correct type.
fcinfo | text The name of the bitmap array. text Name of the Range variable that provides the range of the array part of the bitmap array. text Name of the Range variable that provides the range of each bitmap in the array. |
bool
True Definition at line 1148 of file veil_interface.c.
Datum veil_clear_bitmap_array | ( | FunctionCallInfo | fcinfo | ) |
veil_clear_bitmap_array(text) returns bool
Clear the bits in an existing BitmapArray.
An error will be raised if the parameter is not of the correct type.
fcinfo | text The name of the BitmapArray. |
bool
True Definition at line 1188 of file veil_interface.c.
Datum veil_bitmap_from_array | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_from_array(text, text, int4) returns text
Place a reference to the specified Bitmap from a BitmapArray into the specified BitmapRef An error will be raised if any parameter is not of the correct type.
fcinfo | text The name of the BitmapRef into which a reference to the relevant Bitmap will be placed. text Name of the BitmapArray containing the Bitmap in which we are interested. int4 Index into the array of the bitmap in question. |
text
The name of the BitmapRef Definition at line 1220 of file veil_interface.c.
Datum veil_bitmap_array_testbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_testbit(text, int4, int4) returns bool
Test a specified bit within a BitmapArray
An error will be raised if the first parameter is not a BitmapArray.
fcinfo | text The name of the BitmapArray int4 Index of the Bitmap within the array. int4 Bit id of the bit within the Bitmap. |
bool
True if the bit was set, false otherwise. Definition at line 1259 of file veil_interface.c.
Datum veil_bitmap_array_setbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_setbit(text, int4, int4) returns bool
Set a specified bit within a BitmapArray
An error will be raised if the first parameter is not a BitmapArray.
fcinfo | text The name of the BitmapArray int4 Index of the Bitmap within the array. int4 Bit id of the bit within the Bitmap. |
bool
True Definition at line 1298 of file veil_interface.c.
Datum veil_bitmap_array_clearbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_clearbit(text, int4, int4) returns bool
Clear a specified bit within a BitmapArray
An error will be raised if the first parameter is not a BitmapArray.
fcinfo | text The name of the BitmapArray int4 Index of the Bitmap within the array. int4 Bit id of the bit within the Bitmap. |
bool
True Definition at line 1343 of file veil_interface.c.
Datum veil_union_from_bitmap_array | ( | FunctionCallInfo | fcinfo | ) |
veil_union_from_bitmap_array(text, text, int4) returns bool
Union a Bitmap with the specified Bitmap from a BitmapArray with the result placed into the first parameter.
An error will be raised if the parameters are not of the correct types.
fcinfo | text The name of the Bitmap into which the resulting union will be placed. text Name of the BitmapArray int4 Index of the required bitmap in the array |
bool
True Definition at line 1390 of file veil_interface.c.
Datum veil_intersect_from_bitmap_array | ( | FunctionCallInfo | fcinfo | ) |
veil_intersect_from_bitmap_array(text, text, int4) returns bool
Intersect a Bitmap with the specified Bitmap from a BitmapArray with the result placed into the first parameter.
An error will be raised if the parameters are not of the correct types.
fcinfo | text The name of the Bitmap into which the resulting intersection will be placed. text Name of the BitmapArray int4 Index of the required bitmap in the array |
bool
True Definition at line 1431 of file veil_interface.c.
Datum veil_bitmap_array_bits | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_bits(text)
returns setof int4 Return the set of all bits set in the specified Bitmap from the BitmapArray.
fcinfo | text The name of the bitmap array. int4 Index of the required bitmap in the array |
setof int4
The set of bits that are set in the bitmap. Definition at line 1469 of file veil_interface.c.
References BitmapArray::arraymax, BitmapArray::arrayzero, ensure_init(), GetBitmapArray(), strfromtext(), and vl_BitmapFromArray().
Datum veil_bitmap_array_arange | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_arange(text) returns veil_range_t
Return composite type giving the range of the array part of the specified BitmapArray
fcinfo | text The name of the bitmap array. |
veil_range_t
Composite type containing the min and max indices of the array Definition at line 1550 of file veil_interface.c.
Datum veil_bitmap_array_brange | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_brange(text) returns veil_range_t
Return composite type giving the range of every Bitmap within the BitmapArray.
fcinfo | text The name of the bitmap array. |
veil_range_t
Composite type containing the min and max values of the bitmap array's range Definition at line 1585 of file veil_interface.c.
Datum veil_init_bitmap_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_init_bitmap_hash(text, text) returns bool
Create or reset a BitmapHash.
An error will be raised if any parameter is not of the correct type.
fcinfo | text The name of the bitmap hash. text Name of the Range variable that provides the range of each bitmap in the hash. |
bool
True Definition at line 1622 of file veil_interface.c.
Datum veil_clear_bitmap_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_clear_bitmap_hash(text) returns bool
Clear the bits in an existing BitmapHash.
An error will be raised if the parameter is not of the correct type.
fcinfo | text The name of the BitmapHash. |
bool
True Definition at line 1667 of file veil_interface.c.
Datum veil_bitmap_hash_key_exists | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hashkey_exists(text, text) returns text
Place a reference to the specified Bitmap from a BitmapHash into the specified BitmapRef An error will be raised if any parameter is not of the correct type.
fcinfo | text Name of the BitmapHashin which we are interested. text Key, into the hash, of the bitmap in question. |
boolean
Whether the key is present in the BitmapHash Definition at line 1701 of file veil_interface.c.
Datum veil_bitmap_from_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_from_hash(text, text, text) returns text
Place a reference to the specified Bitmap from a BitmapHash into the specified BitmapRef An error will be raised if any parameter is not of the correct type.
fcinfo | text The name of the BitmapRef into which a reference to the relevant Bitmap will be placed. text Name of the BitmapHash containing the Bitmap in which we are interested. text Key, into the hash, of the bitmap in question. |
text
The name of the BitmapRef Definition at line 1734 of file veil_interface.c.
Datum veil_bitmap_hash_testbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_testbit(text, text, int4) returns bool
Test a specified bit within a BitmapHash
An error will be raised if the first parameter is not a BitmapHash.
fcinfo | text The name of the BitmapHash text Key of the Bitmap within the hash. int4 Bit id of the bit within the Bitmap. |
bool
True if the bit was set, false otherwise. Definition at line 1773 of file veil_interface.c.
Datum veil_bitmap_hash_setbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_setbit(text, text, int4) returns bool
Set a specified bit within a BitmapHash
An error will be raised if the first parameter is not a BitmapHash.
fcinfo | text The name of the BitmapHash text Key of the Bitmap within the hash. int4 Bit id of the bit within the Bitmap. |
bool
True Definition at line 1811 of file veil_interface.c.
Datum veil_bitmap_hash_clearbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_clearbit(text, text, int4) returns bool
Clear a specified bit within a BitmapHash
An error will be raised if the first parameter is not a BitmapHash.
fcinfo | text The name of the BitmapHash text Key of the Bitmap within the hash. int4 Bit id of the bit within the Bitmap. |
bool
True Definition at line 1846 of file veil_interface.c.
Datum veil_union_into_bitmap_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_union_into_bitmap_hash(text, text, text) returns bool
Union a Bitmap with the specified Bitmap from a BitmapHash with the result placed into the bitmap hash.
An error will be raised if the parameters are not of the correct types.
fcinfo | text Name of the BitmapHash text Key of the required bitmap in the hash text The name of the Bitmap into which the resulting union will be placed. |
bool
True Definition at line 1883 of file veil_interface.c.
Datum veil_union_from_bitmap_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_union_from_bitmap_hash(text, text, text) returns bool
Union a Bitmap with the specified Bitmap from a BitmapHash with the result placed into the bitmap parameter.
An error will be raised if the parameters are not of the correct types.
fcinfo | text The name of the Bitmap into which the resulting union will be placed. text Name of the BitmapHash text Key of the required bitmap in the hash |
bool
True Definition at line 1923 of file veil_interface.c.
Datum veil_intersect_from_bitmap_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_intersect_from_bitmap_hash(text, text, text) returns bool
Intersect a Bitmap with the specified Bitmap from a BitmapArray with the result placed into the bitmap parameter.
An error will be raised if the parameters are not of the correct types.
fcinfo | text The name of the Bitmap into which the resulting intersection will be placed. text Name of the BitmapHash text Key of the required bitmap in the hash |
bool
True Definition at line 1963 of file veil_interface.c.
Datum veil_bitmap_hash_bits | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_bits(text)
returns setof int4 Return the set of all bits set in the specified Bitmap from the BitmapHash.
fcinfo | text The name of the bitmap hash. text Key of the required bitmap in the hash |
setof int4
The set of bits that are set in the bitmap. Definition at line 2005 of file veil_interface.c.
References ensure_init(), GetBitmapHash(), strfromtext(), and vl_BitmapFromHash().
Datum veil_bitmap_hash_range | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_range(text) returns veil_range_t
Return composite type giving the range of every Bitmap within the BitmapHash.
fcinfo | text The name of the bitmap array. |
veil_range_t
Composite type containing the min and max values of the bitmap hash's range Definition at line 2076 of file veil_interface.c.
Datum veil_bitmap_hash_entries | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_entries(text) returns setof text
Return the key of every Bitmap within the BitmapHash.
fcinfo | text The name of the bitmap hash. |
setof text
Every key in the hash. Definition at line 2106 of file veil_interface.c.
Datum veil_bitmap_hash_defined | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_defined(text, text) returns bool
Return true if the key exists in the bitmap hash.
fcinfo | text The name of the bitmap hash. text Key of the required bitmap in the hash |
bool
True if key is defined in the hash Definition at line 2169 of file veil_interface.c.
Datum veil_int4_set | ( | FunctionCallInfo | fcinfo | ) |
veil_int4_set(text, int4) returns int4
Set an Int4Var variable type to a specified value.
An Error will be raised if the variable is not defined or is of the wrong type.
fcinfo | text The name of the int4 variable. | |
fcinfo | int4 The value to be set (may be null). |
int4
The new value of the variable. Definition at line 2200 of file veil_interface.c.
Datum veil_int4_get | ( | FunctionCallInfo | fcinfo | ) |
veil_int4_get(text) returns int4
Return the value of an Int4Var variable.
An Error will be raised if the variable is not defined or is of the wrong type.
fcinfo | text The name of the int4 variable. |
int4
The value of the variable. Definition at line 2238 of file veil_interface.c.
Datum veil_init_int4array | ( | FunctionCallInfo | fcinfo | ) |
veil_init_int4array(text, text) returns bool
Initialise an Int4Array variable.
Each entry in the array will be zeroed.
fcinfo | text The name of the Int4Array variable. text Name of the range variable defining the size of the array. |
bool
True Definition at line 2269 of file veil_interface.c.
Datum veil_clear_int4array | ( | FunctionCallInfo | fcinfo | ) |
veil_clear_int4array(text) returns bool
Clear an Int4Array variable.
Each entry in the array will be zeroed.
fcinfo | text The name of the Int4Array variable. |
bool
True Definition at line 2303 of file veil_interface.c.
References ensure_init(), GetInt4Array(), strfromtext(), and vl_Int4ArraySet().
Datum veil_int4array_set | ( | FunctionCallInfo | fcinfo | ) |
veil_int4array_set(text, int4, int4) returns int4
Set an Int4Array entry.
fcinfo | text The name of the Int4Array variable. int4 Index of the entry to be set int4 Value to which the entry will be set |
int4
The new value of the array entry Definition at line 2329 of file veil_interface.c.
Datum veil_int4array_get | ( | FunctionCallInfo | fcinfo | ) |
veil_int4array_get(text, int4) returns int4
Get an Int4Array entry.
fcinfo | text The name of the Int4Array variable. int4 Index of the entry to be retrieved |
int4
The value of the array entry Definition at line 2357 of file veil_interface.c.
Datum veil_init | ( | FunctionCallInfo | fcinfo | ) |
veil_init(bool) returns bool
Initialise or reset a veil session.
The boolean parameter will be false when called for initialisation, and true when performing a reset.
This function must be redefined as a custom function in your implementation.
fcinfo | bool Whether we are being called in order to reset (true) the session or (false) simply to initialise it. |
bool
True Definition at line 2390 of file veil_interface.c.
References ensure_init(), vl_bool_from_query(), and vl_prepare_context_switch().
Datum veil_perform_reset | ( | FunctionCallInfo | fcinfo | ) |
veil_perform_reset() returns bool
Reset veil shared memory for this database.
This creates a new shared memory context with none of the existing shared variables. All current transactions will be able to continue using the current variables, all new transactions will see the new set, once this function has completed.
fcinfo |
bool
True if the function is able to complete successfully. If it is unable, no harm will have been done but neither will a memory reset have been performed. Definition at line 2416 of file veil_interface.c.
Datum veil_force_reset | ( | FunctionCallInfo | fcinfo | ) |
veil_force_reset() returns bool
Reset veil shared memory for this database, ignoring existing transactions.
This function will always reset the shared memory context, even for sessions that are still using it. Having taken this drastic action, it will then cause a panic to reset the server.
Question - won't a panic reset the shared memory in any case? Is the panic superfluous, or maybe is this entire function superfluous?
fcinfo |
bool
True. Definition at line 2480 of file veil_interface.c.
Datum veil_version | ( | FunctionCallInfo | fcinfo | ) |
veil_version() returns text
Return a string describing this version of veil.
fcinfo |
text
String describing the version. Definition at line 2497 of file veil_interface.c.
Datum veil_serialise | ( | FunctionCallInfo | fcinfo | ) |
veil_serialise(text) returns text
Return a string describing this version of veil.
fcinfo | text Name of the variable to be serialised. |
text
String containing the serialised variable. Definition at line 2520 of file veil_interface.c.
References ensure_init(), strfromtext(), and vl_deserialise().
Datum veil_deserialise | ( | FunctionCallInfo | fcinfo | ) |
veil_deserialise(text) returns text
Create or reset variables based on the output of previous veil_serialise calls.
fcinfo | text Serialised variables string |
int4
Count of the items de-serialised from the string. Definition at line 2555 of file veil_interface.c.