Author: Marc Munro Copyright (c) 2005 - 2011 Marc Munro License: BSD
Definition in file veil_interface.c.
#include "postgres.h"
#include "access/xact.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.
Functions | |
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. | |
Datum | veil_variables (FunctionCallInfo fcinfo) |
veil_variables() returns setof veil_variable_t Return a veil_variable_t record for each defined variable. | |
Datum | veil_share (FunctionCallInfo fcinfo) |
veil_share(name text) returns bool Define a shared variable called NAME, returning true. | |
Datum | veil_init_range (FunctionCallInfo fcinfo) |
veil_init_range(name text, min int4, max int4) returns int4 Initialise a Range variable called NAME constrained by MIN and MAX, returning the number of elements in the range. | |
static Datum | datum_from_range (int32 min, int32 max) |
Create a datum containing the values of a veil_range_t composite type. | |
Datum | veil_range (FunctionCallInfo fcinfo) |
veil_range(name text) returns veil_range_t Return the range (as a SQL veil_range_t composite type) from the named variable. | |
Datum | veil_init_bitmap (FunctionCallInfo fcinfo) |
veil_init_bitmap(bitmap_name text, range_nametext) returns bool Create or re-initialise a Bitmap, for dealing with a named range of values. | |
Datum | veil_clear_bitmap (FunctionCallInfo fcinfo) |
veil_clear_bitmap(name text) returns bool Clear all bits in the specified Bitmap. | |
Datum | veil_bitmap_setbit (FunctionCallInfo fcinfo) |
veil_bitmap_setbit(name text, bit_number int4) returns bool Set the specified bit in the specified Bitmap. | |
Datum | veil_bitmap_clearbit (FunctionCallInfo fcinfo) |
veil_bitmap_clearbit(name int4, bit_number text) returns bool Clear the specified bit in the specified Bitmap. | |
Datum | veil_bitmap_testbit (FunctionCallInfo fcinfo) |
veil_bitmap_testbit(name text, bit_number int4) returns bool Test the specified bit in the specified Bitmap, returning true if it is set. | |
Datum | veil_bitmap_union (FunctionCallInfo fcinfo) |
veil_bitmap_union(result_name text, name2 text) returns bool Union the bitmap specified in parameter 1 with that in parameter 2, with the result in parameter 1. | |
Datum | veil_bitmap_intersect (FunctionCallInfo fcinfo) |
veil_bitmap_intersect(result_name text, name2 text) returns bool Intersect the bitmap specified in parameter 1 with that in parameter 2, with the result in parameter 1. | |
Datum | veil_bitmap_bits (FunctionCallInfo fcinfo) |
veil_bitmap_bits(name text) returns setof int4 Return the set of all bits set in the specified Bitmap or BitmapRef. | |
Datum | veil_bitmap_range (FunctionCallInfo fcinfo) |
veil_bitmap_range(name text) returns veil_range_t Return composite type giving the range of the specified Bitmap or BitmapRef. | |
Datum | veil_init_bitmap_array (FunctionCallInfo fcinfo) |
veil_init_bitmap_array(text, text, text) returns bool Create or reset a BitmapArray. | |
Datum | veil_clear_bitmap_array (FunctionCallInfo fcinfo) |
veil_clear_bitmap_array(bmarray text) returns bool Clear the bits in an existing BitmapArray. | |
Datum | veil_bitmap_from_array (FunctionCallInfo fcinfo) |
veil_bitmap_from_array(bmref text, bmarray text, index 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. | |
Datum | veil_bitmap_array_testbit (FunctionCallInfo fcinfo) |
veil_bitmap_array_testbit(bmarray text, arr_idx int4, bitno int4) returns bool Test a specified bit within a BitmapArray | |
Datum | veil_bitmap_array_setbit (FunctionCallInfo fcinfo) |
veil_bitmap_array_setbit(bmarray text, arr_idx int4, bitno int4) returns bool Set a specified bit within a BitmapArray | |
Datum | veil_bitmap_array_clearbit (FunctionCallInfo fcinfo) |
veil_bitmap_array_clearbit(bmarray text, arr_idx int4, bitno int4) returns bool Clear a specified bit within a BitmapArray | |
Datum | veil_union_from_bitmap_array (FunctionCallInfo fcinfo) |
veil_union_from_bitmap_array(bitmap text, bmarray text, arr_idx int4) returns bool Union a Bitmap with the specified Bitmap from a BitmapArray with the result placed into the first parameter. | |
Datum | veil_intersect_from_bitmap_array (FunctionCallInfo fcinfo) |
veil_intersect_from_bitmap_array(bitmap text, bmarray text, arr_idx int4) returns bool Intersect a Bitmap with the specified Bitmap from a BitmapArray with the result placed into the first parameter. | |
Datum | veil_bitmap_array_bits (FunctionCallInfo fcinfo) |
veil_bitmap_array_bits(bmarray text, arr_idx int4) returns setof int4 Return the set of all bits set in the specified Bitmap from the BitmapArray. | |
Datum | veil_bitmap_array_arange (FunctionCallInfo fcinfo) |
veil_bitmap_array_arange(bmarray text) returns veil_range_t Return composite type giving the range of the array part of the specified BitmapArray | |
Datum | veil_bitmap_array_brange (FunctionCallInfo fcinfo) |
veil_bitmap_array_brange(bmarray text) returns veil_range_t Return composite type giving the range of every Bitmap within the BitmapArray. | |
Datum | veil_init_bitmap_hash (FunctionCallInfo fcinfo) |
veil_init_bitmap_hash(bmhash text, range text) returns bool Create or reset a BitmapHash. | |
Datum | veil_clear_bitmap_hash (FunctionCallInfo fcinfo) |
veil_clear_bitmap_hash(bmhash text) returns bool Clear the bits in an existing BitmapHash. | |
Datum | veil_bitmap_hash_key_exists (FunctionCallInfo fcinfo) |
veil_bitmap_hashkey_exists(bmhash text, key text) returns bool Return true if the key exists in the bitmap hash. | |
Datum | veil_bitmap_from_hash (FunctionCallInfo fcinfo) |
veil_bitmap_from_hash(bmref text, bmhash text, key 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. | |
Datum | veil_bitmap_hash_testbit (FunctionCallInfo fcinfo) |
veil_bitmap_hash_testbit(bmhash text, key text, bitno int4) returns bool Test a specified bit within a BitmapHash | |
Datum | veil_bitmap_hash_setbit (FunctionCallInfo fcinfo) |
veil_bitmap_hash_setbit(bmhash text, key text, bitno int4) returns bool Set a specified bit within a BitmapHash | |
Datum | veil_bitmap_hash_clearbit (FunctionCallInfo fcinfo) |
veil_bitmap_hash_clearbit(bmhash text, key text, bitno int4) returns bool Clear a specified bit within a BitmapHash | |
Datum | veil_union_into_bitmap_hash (FunctionCallInfo fcinfo) |
veil_union_into_bitmap_hash(bmhash text, key text, bitmap text) returns bool Union a Bitmap with the specified Bitmap from a BitmapHash with the result placed into the bitmap hash. | |
Datum | veil_union_from_bitmap_hash (FunctionCallInfo fcinfo) |
veil_union_from_bitmap_hash(bmhash text, key text, bitmap text) returns bool Union a Bitmap with the specified Bitmap from a BitmapHash with the result placed into the bitmap parameter. | |
Datum | veil_intersect_from_bitmap_hash (FunctionCallInfo fcinfo) |
veil_intersect_from_bitmap_hash(bitmap text, bmhash text, key text) returns bool Intersect a Bitmap with the specified Bitmap from a BitmapArray with the result placed into the bitmap parameter. | |
Datum | veil_bitmap_hash_bits (FunctionCallInfo fcinfo) |
veil_bitmap_hash_bits(bmhash text, key text) returns setof int4 Return the set of all bits set in the specified Bitmap from the BitmapHash. | |
Datum | veil_bitmap_hash_range (FunctionCallInfo fcinfo) |
veil_bitmap_hash_range(bmhash text) returns veil_range_t Return composite type giving the range of every Bitmap within the BitmapHash. | |
Datum | veil_bitmap_hash_entries (FunctionCallInfo fcinfo) |
veil_bitmap_hash_entries(bmhash text) returns setof text Return the key of every Bitmap within the BitmapHash. | |
Datum | veil_int4_set (FunctionCallInfo fcinfo) |
veil_int4_set(name text,value int4) returns int4 Set an Int4Var variable type to a specified value. | |
Datum | veil_int4_get (FunctionCallInfo fcinfo) |
veil_int4_get(name text) returns int4 Return the value of an Int4Var variable. | |
Datum | veil_init_int4array (FunctionCallInfo fcinfo) |
veil_init_int4array(arrayname text, range text) returns bool Initialise an Int4Array variable. | |
Datum | veil_clear_int4array (FunctionCallInfo fcinfo) |
veil_clear_int4array(name text) returns bool Clear an Int4Array variable. | |
Datum | veil_int4array_set (FunctionCallInfo fcinfo) |
veil_int4array_set(array text, idx int4, value int4) returns int4 Set an Int4Array entry. | |
Datum | veil_int4array_get (FunctionCallInfo fcinfo) |
veil_int4array_get(array text, idx int4) returns int4 Get an Int4Array entry. | |
Datum | veil_init (FunctionCallInfo fcinfo) |
veil_init(doing_reset bool) returns bool Initialise or reset a veil session. | |
Datum | veil_perform_reset (FunctionCallInfo fcinfo) |
veil_perform_reset() returns bool Reset veil shared memory for this database. | |
Datum | veil_force_reset (FunctionCallInfo fcinfo) |
veil_force_reset() returns bool Reset veil shared memory for this database, ignoring existing transactions. | |
Datum | veil_version (FunctionCallInfo fcinfo) |
veil_version() returns text Return a string describing this version of veil. | |
Datum | veil_serialise (FunctionCallInfo fcinfo) |
veil_serialise(varname text) returns text Return a string representing the contents of our variable. | |
Datum | veil_deserialise (FunctionCallInfo fcinfo) |
veil_deserialise(stream text) returns text Create or reset variables based on the output of previous veil_serialise calls. |
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 36 of file veil_interface.c.
Referenced by veil_bitmap_array_bits(), veil_bitmap_bits(), veil_clear_int4array(), veil_int4_get(), veil_int4array_set(), 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 52 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 71 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 95 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 109 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 124 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 145 of file veil_interface.c.
References vl_bool_from_query(), vl_get_shared_hash(), vl_spi_connect(), and vl_spi_finish().
Referenced by veil_bitmap_array_bits(), veil_bitmap_bits(), veil_clear_int4array(), veil_init(), veil_int4_get(), veil_int4array_set(), 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 204 of file veil_interface.c.
References vl_ObjTypeName().
Referenced by deserialise_bitmap_array(), deserialise_bitmap_hash(), deserialise_int4array(), deserialise_int4var(), deserialise_one_bitmap(), deserialise_range(), 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 227 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 264 of file veil_interface.c.
Referenced by veil_int4_get().
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 304 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 355 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 378 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 416 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 439 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 471 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 495 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 527 of file veil_interface.c.
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 551 of file veil_interface.c.
References VarEntry::key, Int4Array::type, and vl_type_mismatch().
Referenced by veil_int4_get().
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 583 of file veil_interface.c.
Referenced by veil_clear_int4array(), and veil_int4array_set().
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 605 of file veil_interface.c.
References ensure_init().
Datum veil_share | ( | FunctionCallInfo | fcinfo | ) |
veil_share(name text) returns bool
Define a shared variable called NAME, returning true.
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 | name text name of variable. |
bool
true if the variable already exists Definition at line 680 of file veil_interface.c.
Datum veil_init_range | ( | FunctionCallInfo | fcinfo | ) |
veil_init_range(name text, min int4, max int4) returns int4 Initialise a Range variable called NAME constrained by MIN and MAX, returning the number of elements in the range.
Ranges may be examined using the veil_range() function.
fcinfo | name text The name of the variable to initialise. min int4 The min value of the range. max int4 The max value of the range. |
int4
The size of the range ((max - min) + 1). Definition at line 708 of file veil_interface.c.
static Datum datum_from_range | ( | int32 | min, | |
int32 | max | |||
) | [static] |
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 737 of file veil_interface.c.
Datum veil_range | ( | FunctionCallInfo | fcinfo | ) |
veil_range(name 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 | name 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 786 of file veil_interface.c.
Datum veil_init_bitmap | ( | FunctionCallInfo | fcinfo | ) |
veil_init_bitmap(bitmap_name text, range_nametext) 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 | bitmap_name text The name of the bitmap to create or reset range_name text The name of a Range variable that defines the range of the new bitmap. |
bool
true Definition at line 817 of file veil_interface.c.
Datum veil_clear_bitmap | ( | FunctionCallInfo | fcinfo | ) |
veil_clear_bitmap(name 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 | name text The name of the bitmap to be cleared. |
bool
true Definition at line 851 of file veil_interface.c.
Datum veil_bitmap_setbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_setbit(name text, bit_number int4) 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 | name text The name of the bitmap variable. bit_number int4 The bit to be set. |
bool
true Definition at line 880 of file veil_interface.c.
Datum veil_bitmap_clearbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_clearbit(name int4, bit_number 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 | name text The name of the bitmap variable. bit_number int4 The bit to be cleared. |
bool
true Definition at line 908 of file veil_interface.c.
Datum veil_bitmap_testbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_testbit(name text, bit_number int4) 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 | name text The name of the bitmap variable. bit_number int4 The bit to be tested. |
bool
true if the bit was set Definition at line 937 of file veil_interface.c.
Datum veil_bitmap_union | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_union(result_name text, name2 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 | result_name text The target bitmap name2 text The bitmap with which to union the target |
bool
true Definition at line 969 of file veil_interface.c.
Datum veil_bitmap_intersect | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_intersect(result_name text, name2 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 | result_name text The target bitmap name2 text The bitmap with which to intersect the target |
bool
true Definition at line 1005 of file veil_interface.c.
Datum veil_bitmap_bits | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_bits(name text)
returns setof int4 Return the set of all bits set in the specified Bitmap or BitmapRef.
fcinfo | name text The name of the bitmap. |
setof int4
The set of bits that are set in the bitmap. Definition at line 1034 of file veil_interface.c.
References ensure_init(), GetBitmap(), and strfromtext().
Datum veil_bitmap_range | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_range(name text) returns veil_range_t
Return composite type giving the range of the specified Bitmap or BitmapRef.
fcinfo | name 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 1099 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 | bmarray text The name of the bitmap array. array_range text Name of the Range variable that provides the range of the array part of the bitmap array. bitmap_range text Name of the Range variable that provides the range of each bitmap in the array. |
bool
True Definition at line 1136 of file veil_interface.c.
Datum veil_clear_bitmap_array | ( | FunctionCallInfo | fcinfo | ) |
veil_clear_bitmap_array(bmarray 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 | bmarray text The name of the BitmapArray. |
bool
True Definition at line 1176 of file veil_interface.c.
Datum veil_bitmap_from_array | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_from_array(bmref text, bmarray text, index 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 | bmref text The name of the BitmapRef into which a reference to the relevant Bitmap will be placed. bmarray text Name of the BitmapArray containing the Bitmap in which we are interested. index int4 Index into the array of the bitmap in question. |
text
The name of the BitmapRef Definition at line 1208 of file veil_interface.c.
Datum veil_bitmap_array_testbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_testbit(bmarray text, arr_idx int4, bitno int4) returns bool
Test a specified bit within a BitmapArray
An error will be raised if the first parameter is not a BitmapArray.
fcinfo | bmarray text The name of the BitmapArray arr_idx int4 Index of the Bitmap within the array. bitno int4 Bit id of the bit within the Bitmap. |
bool
True if the bit was set, false otherwise. Definition at line 1254 of file veil_interface.c.
Datum veil_bitmap_array_setbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_setbit(bmarray text, arr_idx int4, bitno int4) returns bool
Set a specified bit within a BitmapArray
An error will be raised if the first parameter is not a BitmapArray.
fcinfo | bmarray text The name of the BitmapArray arr_idx int4 Index of the Bitmap within the array. ibitno nt4 Bit id of the bit within the Bitmap. |
bool
True Definition at line 1293 of file veil_interface.c.
Datum veil_bitmap_array_clearbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_clearbit(bmarray text, arr_idx int4, bitno int4) returns bool
Clear a specified bit within a BitmapArray
An error will be raised if the first parameter is not a BitmapArray.
fcinfo | bmarray text The name of the BitmapArray arr_idx int4 Index of the Bitmap within the array. bitno int4 Bit id of the bit within the Bitmap. |
bool
True Definition at line 1339 of file veil_interface.c.
Datum veil_union_from_bitmap_array | ( | FunctionCallInfo | fcinfo | ) |
veil_union_from_bitmap_array(bitmap text, bmarray text, arr_idx 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 | bitmap text The name of the Bitmap into which the resulting union will be placed. bmarray text Name of the BitmapArray arr_idx int4 Index of the required bitmap in the array |
bool
True Definition at line 1387 of file veil_interface.c.
Datum veil_intersect_from_bitmap_array | ( | FunctionCallInfo | fcinfo | ) |
veil_intersect_from_bitmap_array(bitmap text, bmarray text, arr_idx 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 | bitmap text The name of the Bitmap into which the resulting intersection will be placed. bmarray text Name of the BitmapArray arr_idx int4 Index of the required bitmap in the array |
bool
True Definition at line 1428 of file veil_interface.c.
Datum veil_bitmap_array_bits | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_bits(bmarray text, arr_idx int4)
returns setof int4 Return the set of all bits set in the specified Bitmap from the BitmapArray.
fcinfo | bmarray text The name of the bitmap array. arr_idx int4 Index of the required bitmap in the array |
setof int4
The set of bits that are set in the bitmap. Definition at line 1466 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(bmarray text) returns veil_range_t
Return composite type giving the range of the array part of the specified BitmapArray
fcinfo | bmarray text The name of the bitmap array. |
veil_range_t
Composite type containing the min and max indices of the array Definition at line 1546 of file veil_interface.c.
Datum veil_bitmap_array_brange | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_array_brange(bmarray text) returns veil_range_t
Return composite type giving the range of every Bitmap within the BitmapArray.
fcinfo | bmarray 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 1581 of file veil_interface.c.
Datum veil_init_bitmap_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_init_bitmap_hash(bmhash text, range text) returns bool
Create or reset a BitmapHash.
An error will be raised if any parameter is not of the correct type.
fcinfo | bmhash text The name of the bitmap hash. range text Name of the Range variable that provides the range of each bitmap in the hash. |
bool
True Definition at line 1618 of file veil_interface.c.
Datum veil_clear_bitmap_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_clear_bitmap_hash(bmhash 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 | bmhash text The name of the BitmapHash. |
bool
True Definition at line 1663 of file veil_interface.c.
Datum veil_bitmap_hash_key_exists | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hashkey_exists(bmhash text, key text) returns bool
Return true if the key exists in the bitmap hash.
fcinfo | bmhash text Name of the BitmapHashin which we are interested. key text Key, into the hash, of the bitmap in question. |
boolean
Whether the key is present in the BitmapHash Definition at line 1695 of file veil_interface.c.
Datum veil_bitmap_from_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_from_hash(bmref text, bmhash text, key 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 | bmref text The name of the BitmapRef into which a reference to the relevant Bitmap will be placed. bmhash text Name of the BitmapHash containing the Bitmap in which we are interested. key text Key, into the hash, of the bitmap in question. |
text
The name of the BitmapRef Definition at line 1727 of file veil_interface.c.
Datum veil_bitmap_hash_testbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_testbit(bmhash text, key text, bitno int4) returns bool
Test a specified bit within a BitmapHash
An error will be raised if the first parameter is not a BitmapHash.
fcinfo | bmhash text The name of the BitmapHash key text Key of the Bitmap within the hash. bitno int4 Bit id of the bit within the Bitmap. |
bool
True if the bit was set, false otherwise. Definition at line 1766 of file veil_interface.c.
Datum veil_bitmap_hash_setbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_setbit(bmhash text, key text, bitno int4) returns bool
Set a specified bit within a BitmapHash
An error will be raised if the first parameter is not a BitmapHash.
fcinfo | bmhash text The name of the BitmapHash key text Key of the Bitmap within the hash. bitno int4 Bit id of the bit within the Bitmap. |
bool
True Definition at line 1805 of file veil_interface.c.
Datum veil_bitmap_hash_clearbit | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_clearbit(bmhash text, key text, bitno int4) returns bool
Clear a specified bit within a BitmapHash
An error will be raised if the first parameter is not a BitmapHash.
fcinfo | bmhash text The name of the BitmapHash key text Key of the Bitmap within the hash. bitno int4 Bit id of the bit within the Bitmap. |
bool
True Definition at line 1840 of file veil_interface.c.
Datum veil_union_into_bitmap_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_union_into_bitmap_hash(bmhash text, key text, bitmap 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 | bmhash text Name of the BitmapHash key text Key of the required bitmap in the hash bitmap text The name of the Bitmap into which the resulting union will be placed. |
bool
True Definition at line 1877 of file veil_interface.c.
Datum veil_union_from_bitmap_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_union_from_bitmap_hash(bmhash text, key text, bitmap 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 | bmhash text The name of the Bitmap into which the resulting union will be placed. key text Name of the BitmapHash bitmap text Key of the required bitmap in the hash |
bool
True Definition at line 1917 of file veil_interface.c.
Datum veil_intersect_from_bitmap_hash | ( | FunctionCallInfo | fcinfo | ) |
veil_intersect_from_bitmap_hash(bitmap text, bmhash text, key 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 | bitmap text The name of the Bitmap into which the resulting intersection will be placed. bmhash text Name of the BitmapHash key text Key of the required bitmap in the hash |
bool
True Definition at line 1957 of file veil_interface.c.
Datum veil_bitmap_hash_bits | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_bits(bmhash text, key text)
returns setof int4 Return the set of all bits set in the specified Bitmap from the BitmapHash.
fcinfo | bmhashtext The name of the bitmap hash. key text Key of the required bitmap in the hash |
setof int4
The set of bits that are set in the bitmap. Definition at line 1999 of file veil_interface.c.
Datum veil_bitmap_hash_range | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_range(bmhash text) returns veil_range_t
Return composite type giving the range of every Bitmap within the BitmapHash.
fcinfo | bmhash 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 2069 of file veil_interface.c.
Datum veil_bitmap_hash_entries | ( | FunctionCallInfo | fcinfo | ) |
veil_bitmap_hash_entries(bmhash text) returns setof text
Return the key of every Bitmap within the BitmapHash.
fcinfo | bmhash text The name of the bitmap hash. |
setof text
Every key in the hash. Definition at line 2099 of file veil_interface.c.
Datum veil_int4_set | ( | FunctionCallInfo | fcinfo | ) |
veil_int4_set(name text,value 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 | name text The name of the int4 variable. | |
fcinfo | value int4 The value to be set (may be null). |
int4
The new value of the variable. Definition at line 2163 of file veil_interface.c.
References Int4Var::isnull, and Int4Var::value.
Datum veil_int4_get | ( | FunctionCallInfo | fcinfo | ) |
veil_int4_get(name 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 | name text The name of the int4 variable. |
int4
The value of the variable. Definition at line 2201 of file veil_interface.c.
References ensure_init(), GetInt4ArrayFromVar(), GetRange(), Range::max, Range::min, VarEntry::obj, VarEntry::shared, strfromtext(), vl_lookup_variable(), and vl_NewInt4Array().
Datum veil_init_int4array | ( | FunctionCallInfo | fcinfo | ) |
veil_init_int4array(arrayname text, range text) returns bool
Initialise an Int4Array variable.
Each entry in the array will be zeroed.
fcinfo | arrayname text The name of the Int4Array variable. range text Name of the range variable defining the size of the array. |
bool
True Definition at line 2231 of file veil_interface.c.
Datum veil_clear_int4array | ( | FunctionCallInfo | fcinfo | ) |
veil_clear_int4array(name text) returns bool
Clear an Int4Array variable.
Each entry in the array will be zeroed.
fcinfo | name text The name of the Int4Array variable. |
bool
True Definition at line 2264 of file veil_interface.c.
References ensure_init(), GetInt4Array(), strfromtext(), and vl_Int4ArraySet().
Datum veil_int4array_set | ( | FunctionCallInfo | fcinfo | ) |
veil_int4array_set(array text, idx int4, value int4) returns int4
Set an Int4Array entry.
fcinfo | array text The name of the Int4Array variable. idx int4 Index of the entry to be set value int4 Value to which the entry will be set |
int4
The new value of the array entry Definition at line 2290 of file veil_interface.c.
References ensure_init(), GetInt4Array(), strfromtext(), and vl_Int4ArrayGet().
Datum veil_int4array_get | ( | FunctionCallInfo | fcinfo | ) |
veil_int4array_get(array text, idx int4) returns int4
Get an Int4Array entry.
fcinfo | array text The name of the Int4Array variable. idx int4 Index of the entry to be retrieved |
int4
The value of the array entry Definition at line 2318 of file veil_interface.c.
References vl_call_init_fns().
Datum veil_init | ( | FunctionCallInfo | fcinfo | ) |
veil_init(doing_reset 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 may be redefined as a custom function in your implementation, or will call initialisation functions registered in the table veil.veil_init_fns.
fcinfo | doing_reset bool Whether we are being called in order to reset (true) the session or (false) simply to initialise it. |
bool
True Definition at line 2353 of file veil_interface.c.
References ensure_init(), vl_bool_from_query(), vl_prepare_context_switch(), and vl_spi_connect().
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 2384 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 2449 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 2466 of file veil_interface.c.
Datum veil_serialise | ( | FunctionCallInfo | fcinfo | ) |
veil_serialise(varname text) returns text
Return a string representing the contents of our variable.
fcinfo | varname text Name of the variable to be serialised. |
text
String containing the serialised variable. Definition at line 2489 of file veil_interface.c.
References ensure_init(), strfromtext(), and vl_deserialise().
Datum veil_deserialise | ( | FunctionCallInfo | fcinfo | ) |
veil_deserialise(stream text) returns text
Create or reset variables based on the output of previous veil_serialise calls.
fcinfo | stream text Serialised variables string |
int4
Count of the items de-serialised from the string. Definition at line 2524 of file veil_interface.c.