[database] element index

Package indexes

All elements
a b c d e f g h i j l m n o p q r s t u v w
a
top
Variable $access_method
DB_dbindex::$access_method in pg-schema-defs.php
Access method, eg. btree, hash etc.
Variable $activated
maintainer::$activated in maintainer-defs.php
True if maintainer has been activated
Variable $affectedrowcount
dbquery::$affectedrowcount in query-defs.php
Number of rows affected by query
Variable $args
dbtrigger::$args in schema-defs.php
Arguments to pass to the function
Variable $arg_types
dbfunction::$arg_types in schema-defs.php
Method addcolumn
DB_dbtable::addcolumn() in pg-schema-defs.php
Return SQL which will create a column in this table. The $column passed in is actually a field object.
Method addcolumn
dbtable::addcolumn() in schema-defs.php
Return SQL which will create a column in this table. The $column passed in is actually a field object.
Method addconstraint
schema::addconstraint() in schema-defs.php
Add a constraint to the schema information.
Method addfield
dbtable::addfield() in schema-defs.php
Add a field to the table.
Method addfunction
schema::addfunction() in schema-defs.php
Add a function to the schema information.
Method addsequence
schema::addsequence() in schema-defs.php
Add a sequence to the schema information.
Method addtable
schema::addtable() in schema-defs.php
Add a table to the schema information.
Method addtrigger
schema::addtrigger() in schema-defs.php
Add a trigger to the schema information.
Method add_database
datasources::add_database() in database-defs.php
Constructor Add a new base to our list of datasources. The dbtype and the name are the only mandatory parameters.
Method affectedrows
datasources::affectedrows() in database-defs.php
Return the number of rows affected by a query.
Method affectedrows
database::affectedrows() in database-defs.php
This method must be defined in the child class.
Constant ALL
ALL in schema-defs.php
Run getchema() in recusrive mode - follow foreign keys
Method autosequence
maintainer::autosequence() in maintainer-defs.php
Auto-detect sequences for integer fields. The technique is to assume sequences are named after the field in the form: 'seq_{fieldname}' and if so then this sequence is associated with the given field named {fieldname}.
b
top
Variable $before
dbtrigger::$before in schema-defs.php
When trigger fires. If true BEFORE, else AFTER event
Method begin_transaction
database::begin_transaction() in database-defs.php
Start a new database transaction.
Method begin_transaction
Start a database transaction
Function begin_transaction
begin_transaction() in query-defs.php
Begin a DB transaction
Method bool_from_db_value
Return a Php boolean from a database field value. The database field is expected to be a container of some form of logical value. Here is where we convert it according to the current database.
Method bool_from_db_value
database::bool_from_db_value() in database-defs.php
Return a Php boolean from a database field value. The database field is expected to be a container of some form of logical value. Here is where we convert it according to the current database.
Method build
sqlquery::build() in query-defs.php
Build the SQL query This takes the various components which have been added to the object and parses them to build the full SQL statement which will be sent to the server. The result is stored in $this->sql.
c
top
Variable $cache
DB_dbsequence::$cache in pg-schema-defs.php
Sequence cache size
Variable $cksrc
dbconstraint::$cksrc in schema-defs.php
Check constraint source
Variable $clustered
DB_dbindex::$clustered in pg-schema-defs.php
True if index is clustered
Variable $connected
database::$connected in database-defs.php
Flag true if database was connected ok
Variable $constraints
dbfield::$constraints in schema-defs.php
Variable $constraints
dbtable::$constraints in schema-defs.php
Array of constraints on this table
Variable $constraints
schema::$constraints in schema-defs.php
Variable $current_row
dbrows::$current_row in query-defs.php
An array containing the current DB row
Variable $current_row
maintainer::$current_row in maintainer-defs.php
Current record/row
Method capable_of
schema::capable_of() in schema-defs.php
Return database capabilities. There are specific capabilities which the diff code needs to query, and this method should be overridden in the specific database module to answer those questions.
Method capable_of
DB_schema::capable_of() in pg-schema-defs.php
Return database capabilities. There are specific capabilities which the diff code needs to query, and this method should be overridden in the specific database module to answer those questions.
Method clear
sqlquery::clear() in query-defs.php
Clear query - Wipe all of the current query definitions.
Function commit
commit() in query-defs.php
Commit a DB transaction
Method commit
datasources::commit() in database-defs.php
Commit open database transaction
Method commit
database::commit() in database-defs.php
Commit the currently open database transaction.
Method connect
datasources::connect() in database-defs.php
Connects to the database which has been selected in the mode specified, or non-peristent otherwise.
Method connect
database::connect() in database-defs.php
This method must be defined in the child class.
Method connected
datasources::connected() in database-defs.php
Returns connected status of named database, or the currently selected one if no name given.
Method constraints_match
dbfield::constraints_match() in schema-defs.php
Return true if field constraints match those passed in.
Method constraint_exists
schema::constraint_exists() in schema-defs.php
Returns true if named constraint exists.
Method convert_boolean_syntax
Make conversions of boolean syntax found in the SQL string and return the 'standardised' SQL. This assumes that Axyl SQL will be written in the form 'WHERE foo=TRUE'.
Method create
dbfunction::create() in schema-defs.php
Method create
dbfield::create() in schema-defs.php
Return SQL to create this field in a table. This represents a portion of the CREATE TABLE script pertaining to this field and it comprises field name, type, and constraints.
Method create
dbsequence::create() in schema-defs.php
Method create
dbtrigger::create() in schema-defs.php
Return SQL required to create this trigger.
Method create
dbtable::create() in schema-defs.php
Return the SQL which will create this table.
Method create
dbindex::create() in schema-defs.php
Return SQL required to create this index.
Method create
dbconstraint::create() in schema-defs.php
Return SQL required to create this constraint outside the table
Method create
DB_dbsequence::create() in pg-schema-defs.php
Return Postgres SQL required to create this sequence.
Method create
DB_dbindex::create() in pg-schema-defs.php
Return SQL required to create this index.
Method create
DB_dbtable::create() in pg-schema-defs.php
Return the SQL which will create this Postgres table.
Method create
DB_dbtrigger::create() in pg-schema-defs.php
Return SQL required to create this trigger.
Method create
DB_dbfunction::create() in pg-schema-defs.php
Return SQL required to create this function.
Method create_constraints
Return SQL to create all constraints for this field..
Method create_constraints
DB_dbtable::create_constraints() in pg-schema-defs.php
Return the SQL which will create the constraints on this table.
Method create_indexes
DB_dbtable::create_indexes() in pg-schema-defs.php
Return the SQL which will create the indexes on this table.
Method create_inline
Return SQL required to create this as an inline table constraint
Method current_sequencevalue
Return the current sequence value, given a sequence name, the table and the field it applies to.
Method current_sequencevalue
Return the current sequence value, given a sequence name, the table and the field it applies to.
Method current_sequencevalue
Get the current sequence value.
d
top
Variable $database
maintainer::$database in maintainer-defs.php
The name of the database containing the table
Variable $database
datasources::$database in database-defs.php
An array of database objects. All databases we can use as datasources
Variable $database_version
schema::$database_version in schema-defs.php
Variable $dbid
database::$dbid in database-defs.php
Unique identifier for database access
Variable $db_name_default
datasources::$db_name_default in database-defs.php
Default database name
Variable $db_name_selected
datasources::$db_name_selected in database-defs.php
Name of currently selected database
Variable $default
dbfield::$default in schema-defs.php
Variable $deferrable
dbconstraint::$deferrable in schema-defs.php
True if constraint is deferrable
Variable $deferred
dbconstraint::$deferred in schema-defs.php
True if constraint is initially deferred
Variable $delete_action
dbconstraint::$delete_action in schema-defs.php
Action to take on delete
Variable $detail_tables
maintainer::$detail_tables in maintainer-defs.php
Array of detail tables. Master-detail relationship.
Variable $do_autosequence
maintainer::$do_autosequence in maintainer-defs.php
If true we auto-detect sequences for integer fields,
Class database
database in database-defs.php
Define a database. This is a parent class to all of the supported
Method database
database::database() in database-defs.php
Constructor
Page database-defs.php
database-defs.php in database-defs.php
Method datasources
datasources::datasources() in database-defs.php
Constructor
Class datasources
datasources in database-defs.php
Datasources A datasources class is just a bunch of databases. If you want to access a database, register it in here first, then you can select it to perform queries on later.
Page db-mssql-server.php
db-mssql-server.php in db-mssql-server.php
Page db-mysql.php
db-mysql.php in db-mysql.php
Page db-odbc.php
db-odbc.php in db-odbc.php
Page db-oracle.php
db-oracle.php in db-oracle.php
Page db-postgres.php
db-postgres.php in db-postgres.php
Function dbcommand
dbcommand() in query-defs.php
Execute a DB command
Class dbconstraint
dbconstraint in schema-defs.php
Defines a database constraint.
Method dbconstraint
dbconstraint::dbconstraint() in schema-defs.php
Method dbdelete
dbdelete::dbdelete() in query-defs.php
Constructor Create a new DB Delete object.
Class dbdelete
dbdelete in query-defs.php
DB Delete class A special case of the dbquery class. This is for deleting rows from the database.
Method dbfield
dbfield::dbfield() in schema-defs.php
Class dbfield
dbfield in schema-defs.php
Class describing a database field of a table.
Method dbfunction
dbfunction::dbfunction() in schema-defs.php
Class dbfunction
dbfunction in schema-defs.php
Defines a database function (procedure).
Method dbid
datasources::dbid() in database-defs.php
Returns the database resource ID of the given database name.
Class dbindex
dbindex in schema-defs.php
Defines a database index.
Method dbindex
dbindex::dbindex() in schema-defs.php
Class dbinsert
dbinsert in query-defs.php
DB Insert class A special case of the dbtablemod class.
Method dbinsert
dbinsert::dbinsert() in query-defs.php
Constructor Create a new DB Insert object. This is for inserting a record into the database.
Class dbquery
dbquery in query-defs.php
DB Query class This class is the one which executes queries against the connected database.
Method dbquery
dbquery::dbquery() in query-defs.php
Constructor Create a new DB Query object.
Class dbrecords
dbrecords in query-defs.php
DB Records class Renders a query into data and allows access to the data either directly or via the usual get first,last,next,previous cursor navigation.
Method dbrecords
dbrecords::dbrecords() in query-defs.php
Constructor Create a new DB Records object.
Function dbrecordset
dbrecordset() in query-defs.php
A wrapper which caters for queries which will return a record set identifier for returning data.
Method dbrows
dbrows::dbrows() in query-defs.php
Constructor Create a new DB Rows object.
Class dbrows
dbrows in query-defs.php
DB Rows class Renders a query into data and allows access to the data either directly or via the usual get first,last,next,previous cursor navigation.
Method dbselect
dbselect::dbselect() in query-defs.php
Constructor Create a new DB Select object. This is for selecting rows from the database, and returning fields from those rows.
Class dbselect
dbselect in query-defs.php
DB Select class A special case of the dbrecords class.
Class dbseq
dbseq in query-defs.php
DB seq class A class which allows the management and use of sequences.
Method dbseq
dbseq::dbseq() in query-defs.php
Create a new object to manage a sequence, optionally specifying the sequence name..
Class dbsequence
dbsequence in schema-defs.php
Defines a database sequence.
Method dbsequence
dbsequence::dbsequence() in schema-defs.php
Method dbtable
dbtable::dbtable() in schema-defs.php
Construct a table of given name and array of primary key fields.
Class dbtable
dbtable in schema-defs.php
Class describing a database table.
Method dbtablemod
dbtablemod::dbtablemod() in query-defs.php
Constructor Create a new DB Insert object. This is for inserting a record into the database.
Class dbtablemod
dbtablemod in query-defs.php
DB tablemod class Parent class for classes which only modify a single table. This means either update or inserts. This class is provided so we can define a common method for sequence definition.
Class dbtrigger
dbtrigger in schema-defs.php
Defines a database trigger.
Method dbtrigger
dbtrigger::dbtrigger() in schema-defs.php
Method dbtype
datasources::dbtype() in database-defs.php
Returns the database type of the given database name.
Class dbupdate
dbupdate in query-defs.php
DB Update class A special case of the dbquery class. This is for updating data in particular rows in the database.
Method dbupdate
dbupdate::dbupdate() in query-defs.php
Constructor Create a new DB Select object.
Class DB_dbconstraint
DB_dbconstraint in pg-schema-defs.php
Defines a database constraint.
Method DB_dbconstraint
Method DB_dbfield
DB_dbfield::DB_dbfield() in pg-schema-defs.php
Class DB_dbfield
DB_dbfield in pg-schema-defs.php
Class describing a database field of a Postgres table.
Method DB_dbfunction
DB_dbfunction::DB_dbfunction() in pg-schema-defs.php
Class DB_dbfunction
DB_dbfunction in pg-schema-defs.php
Defines a database function (procedure).
Method DB_dbindex
DB_dbindex::DB_dbindex() in pg-schema-defs.php
Class DB_dbindex
DB_dbindex in pg-schema-defs.php
Defines a database index.
Method DB_dbsequence
DB_dbsequence::DB_dbsequence() in pg-schema-defs.php
Class DB_dbsequence
DB_dbsequence in pg-schema-defs.php
Defines a database sequence.
Method DB_dbtable
DB_dbtable::DB_dbtable() in pg-schema-defs.php
Construct a table of given name and array of primary key fields.
Class DB_dbtable
DB_dbtable in pg-schema-defs.php
Class describing a Postgres database table. Inherits the standard dbtable class properties and methods, but adds in the getschema specifics for acquiring Postgres table info from the metadata, and provides a specific create() method.
Method DB_dbtrigger
DB_dbtrigger::DB_dbtrigger() in pg-schema-defs.php
Class DB_dbtrigger
DB_dbtrigger in pg-schema-defs.php
Defines a database trigger.
Class DB_schema
DB_schema in pg-schema-defs.php
Class describing a Postgres database schema.
Method DB_schema
DB_schema::DB_schema() in pg-schema-defs.php
Create a schema (database) of given name. The name should be a valid existing database name that is currently connected.
Method db_value_from_bool
Return a suitable database field value to contain the value for the given boolean.
Method db_value_from_bool
database::db_value_from_bool() in database-defs.php
Return a suitable database field value to contain the value for the given boolean.
Constant DEFAULT_DATASOURCE
DEFAULT_DATASOURCE in database-defs.php
Default datasource for queries @see add_database()
Method detail_table
maintainer::detail_table() in maintainer-defs.php
Associates a detail table with the maintained table. This defines
Method diff
schema::diff() in schema-defs.php
Produce the SQL required to morph the schema described in the passed dbschema object $db, into the schema we have in this current object.
Method disable_autosequence
maintainer::disable_autosequence() in maintainer-defs.php
Specify that the maintainer should not auto-detect sequences which
Method disconnect
datasources::disconnect() in database-defs.php
Disconnect the currently selected database.
Method disconnect
database::disconnect() in database-defs.php
This method must be defined in the child class.
Method drop
DB_dbindex::drop() in pg-schema-defs.php
Method drop
dbtrigger::drop() in schema-defs.php
Method drop
DB_dbfunction::drop() in pg-schema-defs.php
Return SQL to drop this function.
Method drop
dbsequence::drop() in schema-defs.php
Method drop
dbtable::drop() in schema-defs.php
Return the SQL to drop this table.
Method drop
dbconstraint::drop() in schema-defs.php
Method drop
dbindex::drop() in schema-defs.php
Method drop
dbfunction::drop() in schema-defs.php
Method drop
dbfield::drop() in schema-defs.php
Return the SQL to drop this field.
Method dropcolumn
dbtable::dropcolumn() in schema-defs.php
Return SQL to drop a column from the table. The $column passed is actually a field object.
Method dump
schema::dump() in schema-defs.php
Dump this entire schema description to stdout.
Method dump
dbtrigger::dump() in schema-defs.php
Dump ascii description of this trigger to stdout.
Method dump
dbfunction::dump() in schema-defs.php
Dump ascii description of this function to stdout.
Method dump
dbconstraint::dump() in schema-defs.php
Dump ascii description of this constraint to stdout.
Method dump
DB_dbfield::dump() in pg-schema-defs.php
Dump field description to stdout.
Method dump
dbfield::dump() in schema-defs.php
Dump field description to stdout.
Method dump
dbindex::dump() in schema-defs.php
Dump ascii description of this index to stdout.
Method dump
dbsequence::dump() in schema-defs.php
Method dump
dbtable::dump() in schema-defs.php
Dump the table description to stdout.
e
top
Variable $eachrow
dbtrigger::$eachrow in schema-defs.php
If true, execute func for EACH ROW else EACH STATEMENT
Variable $encrypted_passwords
maintainer::$encrypted_passwords in maintainer-defs.php
If true, password field content is encrypted
Variable $enctype
maintainer::$enctype in maintainer-defs.php
Maintainers form encoding type
Variable $executable_sql
database::$executable_sql in database-defs.php
The SQL statement last executed on this database. This
Method eof
dbrows::eof() in query-defs.php
Return the EOF (end-of-file) indicator for this query. Returns true if no more results can be returned with get_next(), ie. we are at the end of the results set.
Method errormessage
datasources::errormessage() in database-defs.php
Return the last error message.
Method errormessage
database::errormessage() in database-defs.php
This method must be defined in the child class.
Method execute
dbquery::execute() in query-defs.php
Exceute the query If we have an SQL phrase, execute it now. We store the result in this->valid, and also return it. If a transaction is open, update the status.
Method execute
dbrows::execute() in query-defs.php
Execute query Execute this query. We override the parent method here simply to ensure we are positioned at the first row.
f
top
Variable $fieldnames
dbconstraint::$fieldnames in schema-defs.php
Array of table field names in constraint
Variable $fieldnames
dbindex::$fieldnames in schema-defs.php
Fieldnames in the index
Variable $fieldnums
DB_dbconstraint::$fieldnums in pg-schema-defs.php
Field positions for fields constraint applies to
Variable $fieldnums
DB_dbindex::$fieldnums in pg-schema-defs.php
Field numbers of fields in index
Variable $fields
dbtable::$fields in schema-defs.php
Array of field objects
Variable $fields
sqlquery::$fields in query-defs.php
List of fields in the query
Variable $fk_fieldnames
dbconstraint::$fk_fieldnames in schema-defs.php
Array of referenced foreign key fieldnames
Variable $fk_fieldnums
DB_dbconstraint::$fk_fieldnums in pg-schema-defs.php
Field positions for fields FK constraint refers to
Variable $fk_table
DB_dbconstraint::$fk_table in pg-schema-defs.php
Table (object) constraint refers to
Variable $fk_tablename
dbconstraint::$fk_tablename in schema-defs.php
Foreign key table name constraint refers to
Variable $formname
maintainer::$formname in maintainer-defs.php
Name of form we will be using
Variable $funcname
dbtrigger::$funcname in schema-defs.php
Name of function to call when triggered
Variable $functions
schema::$functions in schema-defs.php
Method fetch_array
datasources::fetch_array() in database-defs.php
Return the specified row, as an associative array of fields in a fieldname => value format.
Method fetch_array
database::fetch_array() in database-defs.php
This method must be defined in the child class.
Method fetch_row
database::fetch_row() in database-defs.php
This method must be defined in the child class.
Method fetch_row
datasources::fetch_row() in database-defs.php
Return the specified row, as a standard (enumerated) array of field values.
Method field
dbrecords::field() in query-defs.php
Get field content Return the field content from the current database array (row).
Method fieldlist
sqlquery::fieldlist() in query-defs.php
Define field list
Method fields
dbconstraint::fields() in schema-defs.php
Constant FIELDS_ONLY
FIELDS_ONLY in schema-defs.php
Run getschema() to get only current table fields (no recursion)
Method fk_fields
dbconstraint::fk_fields() in schema-defs.php
Method freeresult
database::freeresult() in database-defs.php
This method must be defined in the child class.
Method freeresult
datasources::freeresult() in database-defs.php
Free the result of a query
Method from
sqlquery::from() in query-defs.php
Define table FROM list
g
top
Variable $groupby
sqlquery::$groupby in query-defs.php
The GROUP BY clause
Method generic_type
DB_dbfield::generic_type() in pg-schema-defs.php
Return the generic type of the field. The generic types are as
Method generic_type
dbfield::generic_type() in schema-defs.php
Return the generic type of the field. The generic types are as
Method getconstraint
schema::getconstraint() in schema-defs.php
Returns constraint object of given name
Method getfield
dbtable::getfield() in schema-defs.php
Returns field object of given name
Method getfieldbynum
dbtable::getfieldbynum() in schema-defs.php
Returns field object of given attnum (order number)
Method getfieldnum
dbtable::getfieldnum() in schema-defs.php
Returns field number of given field name
Method getfunction
schema::getfunction() in schema-defs.php
Returns function object of given name
Method getfunctions
DB_schema::getfunctions() in pg-schema-defs.php
Populates our array of functions with all user functions in this schema.
Method getindex
schema::getindex() in schema-defs.php
Returns index object of given name
Method getkeyfieldnames
dbtable::getkeyfieldnames() in schema-defs.php
Returns list of names of keyfields as array
Method getlabelfield
dbtable::getlabelfield() in schema-defs.php
Returns a candidate label field name according to some fairly simple heuristics. This would be a field suitable for displaying in a listbox which is somewhat more informative than a keyfield. If nothing is found then the key is used as fallback.
Method getnonkeyfieldnames
Returns list of names of non-keyfields as array
Method getschema
dbfunction::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
schema::getschema() in schema-defs.php
Acquire all of the schema details.
Method getschema
dbindex::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
dbsequence::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
dbtrigger::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
dbtable::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
dbconstraint::getschema() in schema-defs.php
Acquires the schema from database metadata.
Method getschema
DB_dbsequence::getschema() in pg-schema-defs.php
Get schema info for sequence
Method getschema
DB_dbtable::getschema() in pg-schema-defs.php
Acquires the table fields and constraints which apply to it.
Method getschema
DB_dbindex::getschema() in pg-schema-defs.php
Obtain index schema information.
Method getschema
DB_dbfunction::getschema() in pg-schema-defs.php
Obtain function schema information.
Method getschema
DB_dbtrigger::getschema() in pg-schema-defs.php
Obtain trigger schema information.
Method getschema
DB_dbconstraint::getschema() in pg-schema-defs.php
Obtain constraint schema information.
Method getschema_table
schema::getschema_table() in schema-defs.php
Acquire the schema details of a specific database table. This method is provided to cater for the common requirement of acquiring details for a specific table, without having to endure the overhead of reading all of the database schema metadata to get it.
Method getschema_table
DB_schema::getschema_table() in pg-schema-defs.php
Acquire the schema details of a specific Postgres table. This method is provided to cater for the common requirement of acquiring details for a specific table, without having to endure the overhead of reading all of the database schema metadata to get it.
Method getsequence
schema::getsequence() in schema-defs.php
Returns seqeuence object of given name
Method getsequences
schema::getsequences() in schema-defs.php
Populates schema sequences.
Method getsequences
DB_schema::getsequences() in pg-schema-defs.php
Populates our array of sequences with all user sequences in this schema.
Method gettable
schema::gettable() in schema-defs.php
Returns table object of given name
Method gettables
DB_schema::gettables() in pg-schema-defs.php
Populates our array of tables with all tables in this schema.
Method gettables
schema::gettables() in schema-defs.php
Populates schema tables.
Method gettrigger
schema::gettrigger() in schema-defs.php
Returns trigger object of given name
Method gettriggers
schema::gettriggers() in schema-defs.php
Populates schema triggers.
Method gettriggers
DB_schema::gettriggers() in pg-schema-defs.php
Populates our array of triggers with all user triggers in this schema.
Method getversion
schema::getversion() in schema-defs.php
Acquire the database version.
Method getversion
DB_schema::getversion() in pg-schema-defs.php
Acquire the Postgres database version. We make some gross assumptions here with regard to standard local Postgres setup. Change as necessary.
Method get_current
dbrows::get_current() in query-defs.php
Get current row If current query is invalid, try to execute it first, then do a get_first(). If query is then valid, return the current row.
Method get_first
dbrows::get_first() in query-defs.php
Get current row If current query is invalid, try to execute it first, then do a get_first(). If query is then valid, return the current row.
Method get_last
dbrows::get_last() in query-defs.php
Get last row If current query is invalid, try to execute it first, then get the last row from the resultset.
Method get_last_sql
datasources::get_last_sql() in database-defs.php
Returns SQL statement most recently executed on the current DB.
Method get_next
dbrows::get_next() in query-defs.php
Get next row If current query is invalid, try to execute it first, then get the next row from the resultset.
Function get_next_sequencevalue
get_next_sequencevalue() in query-defs.php
A wrapper to get the next sequence value from a named sequence..
Method get_previous
dbrows::get_previous() in query-defs.php
Get previous row If current query is invalid, try to execute it first, then get the previous row from the resultset.
Method get_row
dbrows::get_row() in query-defs.php
Get row Return the given database row from the resultset. Uses the get_row_raw() method applicable to this class.
Method groupby
sqlquery::groupby() in query-defs.php
Define group by field list The fields can be an array, or a delimited list. If the latter, then default delimiter is a comma, unless you specify your own.
h
top
Variable $hasdata
dbquery::$hasdata in query-defs.php
True if data was returned, after execute
Variable $hidden_buttons
maintainer::$hidden_buttons in maintainer-defs.php
Array of disallowed button names eg:
Variable $host
database::$host in database-defs.php
Host server of this database
Method hide_statusbar
maintainer::hide_statusbar() in maintainer-defs.php
Specify whether the maintainer should show its status bar or not.
Method html
maintainer::html() in maintainer-defs.php
Render the maintainer as HTML. Use the render() method rather than directly calling this method.
i
top
Variable $increment
DB_dbsequence::$increment in pg-schema-defs.php
Sequence increment
Variable $indexes
dbtable::$indexes in schema-defs.php
Array of indexes on this table
Variable $indexes
schema::$indexes in schema-defs.php
Variable $isarray
DB_dbfield::$isarray in pg-schema-defs.php
Whether this field is an array of values
Variable $ispkey
dbfield::$ispkey in schema-defs.php
Method index_exists
schema::index_exists() in schema-defs.php
Returns true if named index exists.
Method into
sqlquery::into() in query-defs.php
Define table INSERT INTO list
Method istrue
dbrecords::istrue() in query-defs.php
Database independent boolean handling. Returns TRUE if the named field in the current row is boolean true according to the rules of the underlying database, else returns FALSE.
Method is_integer_class
dbfield::is_integer_class() in schema-defs.php
Return true if the field is of an integer class.
Method is_integer_class
DB_dbfield::is_integer_class() in pg-schema-defs.php
Return true if the field is of an integer class. We exclude the serial types due to the initial purpose of this method - to determine fields which are standalone integer types, without attached sequences.
Method is_serial_class
dbfield::is_serial_class() in schema-defs.php
Return true if the field is of a 'serial' class. This is a pseudo class of types which encapsulates integer fields which are able to auto-increment themselves when records are inserted.
Method is_serial_class
DB_dbfield::is_serial_class() in pg-schema-defs.php
Return true if the field is of a 'serial' class. This is a pseudo class of types which encapsulates integer fields which are able to auto-increment themselves when records are inserted.
j
top
Variable $joined_tables
maintainer::$joined_tables in maintainer-defs.php
Array of joined tables. Tables with a 1-to-1 link.
Method joined_table
maintainer::joined_table() in maintainer-defs.php
Associates a table with the maintained table. This is a table with a 1-to-1 or 1-to-many relationship with the table being maintained.
l
top
Variable $language
dbfunction::$language in schema-defs.php
Variable $last_errormsg
dbquery::$last_errormsg in query-defs.php
Record last error/info message
Variable $limit
sqlquery::$limit in query-defs.php
The LIMIT value
Variable $linked_tables
maintainer::$linked_tables in maintainer-defs.php
Array of linked tables. Tables forming many-to-many link.
Method limit
sqlquery::limit() in query-defs.php
Define query LIMIT
Method linked_table
maintainer::linked_table() in maintainer-defs.php
Associates a table with the maintained table via a link-table.
Method lock
datasources::lock() in database-defs.php
General-purpose lock method. We pass the elements of the lock, which is the list of tables to lock, and the lock-mode. The latter mode is database-specific, and therefore flexible.
Function lock
lock() in query-defs.php
Take out a lock on a table or tables, in a given mode. The mode string is database-specific and will vary according to the implementation of its locking scheme.
Method lock
database::lock() in database-defs.php
This method must be defined in the child class.
Function lockrows_exclusive
lockrows_exclusive() in db-postgres.php
Lock table in ROW EXCLUSIVE MODE
Function lockrows_share
lockrows_share() in db-postgres.php
Lock table in ROW SHARE MODE
Function locktable_exclusive
locktable_exclusive() in db-postgres.php
Lock table in EXCLUSIVE MODE Locks the whole table exclusively. This is very restrictive and prevents any other process getting a share lock on the records (any of them) in the table.
Function locktable_share
locktable_share() in db-postgres.php
Lock table in SHARE MODE Holds the whole table in share lock mode. This makes sure that no exclusive locks can be acquired and so holds the data in the table constant for the transaction.
m
top
Variable $match_type
dbconstraint::$match_type in schema-defs.php
Match type for keys
Variable $maxvalue
DB_dbsequence::$maxvalue in pg-schema-defs.php
Sequence max value
Variable $minvalue
DB_dbsequence::$minvalue in pg-schema-defs.php
Sequence minimum value
Class maintainer
maintainer in maintainer-defs.php
Class comprising functionality which allows a database table to be maintained through a user interface which allows the usual Add, Modify, Delete options, but which gets just about all the info it requires from the database schema itself. A dynamic maintainer.
Method maintainer
maintainer::maintainer() in maintainer-defs.php
Create a new maintainer.
Page maintainer-defs.php
maintainer-defs.php in maintainer-defs.php
Method matches
dbconstraint::matches() in schema-defs.php
n
top
Variable $name
SchemaObject::$name in schema-defs.php
Name of this schema object
Variable $name
database::$name in database-defs.php
Name of this database
Variable $notnull
dbfield::$notnull in schema-defs.php
Variable $num
dbfield::$num in schema-defs.php
Method newfield
DB_dbtable::newfield() in pg-schema-defs.php
Create a new field in the table with given parameters.
Method newfield
dbtable::newfield() in schema-defs.php
Create a new field in the table with given parameters.
Method next_sequencevalue
Set the next sequence value for a column, using either a named sequence or, if that is nullstring or the underlying DB does not support sequences, other means. See the next_sequencevalue() method in the underlying DB module db-xxxx.php.
Method next_sequencevalue
dbseq::next_sequencevalue() in query-defs.php
Get the next sequence value. We can optionally specify the table and
Method next_sequencevalue
database::next_sequencevalue() in database-defs.php
Return the next sequence value, given a sequence name, the table and the field it applies to.
Method next_sequencevalue
Return the next sequence value, given a sequence name, the table and the field it applies to.
Constant NOT_PERSISTENT
NOT_PERSISTENT in database-defs.php
Connect non-persistent to DB
Constant NO_ROLLBACK_ON_FAIL
NO_ROLLBACK_ON_FAIL in query-defs.php
Transaction response to failure - do nothing
Constant NULLVALUE
NULLVALUE in query-defs.php
This value indicates a NULL field value for queries
Method numrows
database::numrows() in database-defs.php
This method must be defined in the child class.
Method numrows
datasources::numrows() in database-defs.php
Return the number of rows returned by a SELECT query.
o
top
Variable $offset
sqlquery::$offset in query-defs.php
The OFFSET value
Variable $ondelete
dbtrigger::$ondelete in schema-defs.php
If true, fire trigger on DELETE
Variable $oninsert
dbtrigger::$oninsert in schema-defs.php
If true, fire trigger on INSERT
Variable $onupdate
dbtrigger::$onupdate in schema-defs.php
If true, fire trigger on UPDATE
Variable $orderby
sqlquery::$orderby in query-defs.php
The ORDER BY clause
Method offset
sqlquery::offset() in query-defs.php
Define query OFFSET
Method orderby
sqlquery::orderby() in query-defs.php
Define order field list Defines the Sort order field list. The fields can be an array, or a delimited list. If the latter, then default delimiter is a comma, unless you specify your own.
p
top
Variable $passwd
database::$passwd in database-defs.php
Default password to connect as
Variable $persistent
database::$persistent in database-defs.php
True if we want a persistent connection
Variable $pkey
dbtable::$pkey in schema-defs.php
Array of field attnum's which are primary keys in table
Variable $port
database::$port in database-defs.php
Port to access it via TCP
Variable $primary
dbindex::$primary in schema-defs.php
True if index is for a primary key
Method parameters
dbfunction::parameters() in schema-defs.php
Return the types parameter list, including brackets.
Constant PERSISTENT
PERSISTENT in database-defs.php
Connect persistent to DB
Page pg-schema-defs.php
pg-schema-defs.php in pg-schema-defs.php
Constant PRIMARY_KEY_ONLY
PRIMARY_KEY_ONLY in schema-defs.php
Run getschema() to get primary key(s) only
q
top
Method query
database::query() in database-defs.php
This method must be defined in the child class.
Method query
datasources::query() in database-defs.php
Execute a query on the connected database.
Page query-defs.php
query-defs.php in query-defs.php
r
top
Variable $recvalid
maintainer::$recvalid in maintainer-defs.php
True if record is valid
Variable $return_type
dbfunction::$return_type in schema-defs.php
Variable $rid
database::$rid in database-defs.php
The result ID last returned by a query on this DB. Also
Variable $rid
dbquery::$rid in query-defs.php
Current row resource ID
Variable $rowcount
maintainer::$rowcount in maintainer-defs.php
Row count - total records in table
Variable $rowcount
dbquery::$rowcount in query-defs.php
Number of rows returned after execute
Variable $rowno
dbquery::$rowno in query-defs.php
Current row in the query
Method rawfield
dbrecords::rawfield() in query-defs.php
Get field content Return the field content from the current database array (row).
Method rebuild
sqlquery::rebuild() in query-defs.php
This is useful when you change some part of the query after it has been executed once, and want it to rebuild the SQL anew before it gets executed again.
Method refresh
dbrows::refresh() in query-defs.php
Refresh the query Re-run the current SQL query. If successful the row will be stored in $this->current_row.
Method rollback
datasources::rollback() in database-defs.php
Roll back the current database transaction. All queries executed as part of the open transaction will be rolled back.
Method rollback
database::rollback() in database-defs.php
Rollback the currently open database transaction.
Function rollback
rollback() in query-defs.php
Rollback a DB transaction
Constant ROLLBACK_ON_FAIL
ROLLBACK_ON_FAIL in query-defs.php
Transaction response to failure - rollback
Method rowexists
dbrows::rowexists() in query-defs.php
Returns true if the row number exists in the returned resultset.
s
top
Variable $schema
maintainer::$schema in maintainer-defs.php
Database schema
Variable $schema
SchemaObject::$schema in schema-defs.php
Reference to the schema object this belongs to
Variable $sequencename
dbseq::$sequencename in query-defs.php
The name of the sequence
Variable $sequences
schema::$sequences in schema-defs.php
Variable $show_recfilter
maintainer::$show_recfilter in maintainer-defs.php
If true we include a built-in record filter
Variable $show_statusbar
maintainer::$show_statusbar in maintainer-defs.php
If true, status bar is displayed
Variable $sql
sqlquery::$sql in query-defs.php
The formatted SQL query itself @see build()
Variable $src
dbfunction::$src in schema-defs.php
Variable $start
DB_dbsequence::$start in pg-schema-defs.php
Sequence start
Variable $strict
DB_dbfunction::$strict in pg-schema-defs.php
Class schema
schema in schema-defs.php
Class describing a database schema. This object hold ALL the information
Method schema
schema::schema() in schema-defs.php
Create a schema (database) of given name. The name should be a valid existing database name that is currently connected. It will be selected to ensure the correct data is obtained.
Page schema-defs.php
schema-defs.php in schema-defs.php
Method SchemaObject
SchemaObject::SchemaObject() in schema-defs.php
Constructor Every schema object must belong to a schema. This is passed as the first argument, as an object reference. It must also have a name, and this is always passed as the second argument, a string.
Class SchemaObject
SchemaObject in schema-defs.php
Defines a virtual object which is used to denote something which is a part of an existing database schema.
Method select
datasources::select() in database-defs.php
This will connect it if it isn't already connected. Calling this with no database name will select the default one. Returns the database unique identifier, or false if none was selected.
Method set
dbconstraint::set() in schema-defs.php
Set constraint variables.
Method set
dbtrigger::set() in schema-defs.php
Set the vars for this trigger
Method set
sqlquery::set() in query-defs.php
Define field assignments Defines the field assignment clauses for UPDATE and INSERT queries.
Method set
dbindex::set() in schema-defs.php
Set index variables.
Method set
dbfunction::set() in schema-defs.php
Set the vars for this function
Method setdefault
dbtable::setdefault() in schema-defs.php
Return SQL to set the default for given field on this table.
Method setnullconstraint
dbtable::setnullconstraint() in schema-defs.php
Return SQL to set the NULL/NOT NULL constraint..
Method setnullconstraint
DB_dbtable::setnullconstraint() in pg-schema-defs.php
Return SQL to set the NULL/NOT NULL constraint..
Method set_allowed_groups
maintainer::set_allowed_groups() in maintainer-defs.php
Restrict access. Use this method to restrict maintainer access to the specified group membership. This will cause the RESPONSE to be sent without any content.
Method set_char_encoding
Set the database character encoding. This affects the encoding of characters in the database.
Method set_char_encoding
database::set_char_encoding() in database-defs.php
This method must be defined in the child class.
Method set_datestyle
database::set_datestyle() in database-defs.php
This method must be defined in the child class.
Method set_datestyle
datasources::set_datestyle() in database-defs.php
Set the database date style. This affect the format that dates will be displayed in, and the format they are submitted in.
Method set_datetimeformat
maintainer::set_datetimeformat() in maintainer-defs.php
Sets a datetime format string for a specified field. This influences the formatting of displayed dates and/or times in that field.
Method set_dbversion
schema::set_dbversion() in schema-defs.php
Set the database version
Method set_default
datasources::set_default() in database-defs.php
Internal function to set the name of the default database.
Method set_disabledfields
maintainer::set_disabledfields() in maintainer-defs.php
Specify that the given fields should be disabled, not editable. Field is seen on screen, but is not modifiable.
Method set_encrypted_passwords
Whether passwords are encrypted or not. If true then we just apply the standard MD5 algorithm to the content.
Method set_fieldblurb
maintainer::set_fieldblurb() in maintainer-defs.php
Associates a string of text 'blurb' with the field. This will be presented just sitting below the field as explanatory text.
Method set_fieldcss
maintainer::set_fieldcss() in maintainer-defs.php
Sets the CSS style/class for a field.
Method set_fielddisplayproc
maintainer::set_fielddisplayproc() in maintainer-defs.php
Associates a function with the field which will be called when data is displayed to format the content. Only really useful for text/memo/numeric fields. The function should accept a string content parameter, and return the re-formatted string content.
Method set_fieldlabel
maintainer::set_fieldlabel() in maintainer-defs.php
Sets the label of the field, which then takes the place of the default naming which uses a proper-cased version of the field name, with underscores replaced by spaces.
Method set_fieldpostproc
maintainer::set_fieldpostproc() in maintainer-defs.php
Associates a function with the field which will be called when data is POSTed to format the content. Only really useful for text/memo/numeric fields. The function should accept a string content parameter, and return the re-formatted string content.
Method set_fieldsequence
maintainer::set_fieldsequence() in maintainer-defs.php
Associates a named sequence with a field. This is so we can create new records using that sequence to populate the record field.
Method set_fieldsize
maintainer::set_fieldsize() in maintainer-defs.php
Sets the size of the field in pixels, width x height
Method set_fieldtexttype
maintainer::set_fieldtexttype() in maintainer-defs.php
Sets the type of a text field. This is a generic type and the
Method set_formenctype
maintainer::set_formenctype() in maintainer-defs.php
Specify the maintainers form encoding type. This will enable us to use file upload fields within the maintainer.
Method set_formfieldwidget
maintainer::set_formfieldwidget() in maintainer-defs.php
Use given user interface element for maintaining specified table field.
Method set_hiddenbuttons
maintainer::set_hiddenbuttons() in maintainer-defs.php
Specify that the given buttons should be hidden. BY default all the usual buttons are available. This method allows you to list those which should NOT be shown. Possible button names are: 'save', 'reset', 'add', 'remove', 'cancel', 'refresh'.
Method set_hiddenfields
maintainer::set_hiddenfields() in maintainer-defs.php
Specify that the given fields should be hidden, not editable. Value will be submitted on POST (save) via hidden field in form.
Method set_labelfields
maintainer::set_labelfields() in maintainer-defs.php
Associates a list of fieldnames on a table to use as the label for a drop-down select reference. This is mainly so you can specify meaningful label strings for drop-down selects on foreign keyed fields, although it will work on any table, not just FKs.
Method set_nonblankfields
maintainer::set_nonblankfields() in maintainer-defs.php
Specify that the given field should be non-blank. This causes a check to be made on form submit and if any field is empty (nullstring) then a warning message is displayed and submit is prevented.
Method set_omittedfields
maintainer::set_omittedfields() in maintainer-defs.php
Specify that the given field should be omitted from the form
Method set_sequencevalue
dbseq::set_sequencevalue() in query-defs.php
Set a sequence value.
Method set_sequencevalue
database::set_sequencevalue() in database-defs.php
This method must be defined in the child class.
Method set_sequencevalue
Set the sequence value, given a sequence name, the table and the field it applies to.
Method set_sql
dbrows::set_sql() in query-defs.php
Set the SQL statement In this case we re-execute the SQL automatically.
Method set_sql
dbquery::set_sql() in query-defs.php
Set the SQL statement
Method set_title
maintainer::set_title() in maintainer-defs.php
Set the title of this maintainer. The default is derived from the name of the maintained table, with 'Maintenance' appended. Otherwise set your own title using this method.
Method set_viewonlyfields
maintainer::set_viewonlyfields() in maintainer-defs.php
Specify that the given field should be displayed on the form as text (view-only) but will not be submitted with the form.
Method SQL
database::SQL() in database-defs.php
Given an Axyl SQL query object, build the SQL string from it in suitable format for the currently connected database server.
Method SQL
datasources::SQL() in database-defs.php
Given an Axyl SQL query object, build the SQL string from it in suitable format for the currently connected database server.
Class sqlquery
sqlquery in query-defs.php
SQLquery class An SQL Statement Text Container.
Method sqlquery
sqlquery::sqlquery() in query-defs.php
Constructor Create a new SQL Query object.
Function start_transaction
start_transaction() in query-defs.php
Start a DB transaction. Alias for begin_transaction()
t
top
Variable $table
DB_dbconstraint::$table in pg-schema-defs.php
Table (object) to apply constraint to
Variable $table
maintainer::$table in maintainer-defs.php
Table requiring maintenance (object)
Variable $tablename
dbindex::$tablename in schema-defs.php
Name of table index is built on
Variable $tablename
dbtrigger::$tablename in schema-defs.php
Name of table to apply trigger to
Variable $tablename
dbconstraint::$tablename in schema-defs.php
Name of table constraint is applied to
Variable $tables
schema::$tables in schema-defs.php
Variable $tables
sqlquery::$tables in query-defs.php
List of tables in the query
Variable $timer
database::$timer in database-defs.php
Microtimer for query execute timing
Variable $title
maintainer::$title in maintainer-defs.php
Title of this maintenance page
Variable $triggers
schema::$triggers in schema-defs.php
Variable $type
dbconstraint::$type in schema-defs.php
Type of constraint 'c' - check, 'p' - pk, 'f' - fk
Variable $type
sqlquery::$type in query-defs.php
Type of query 'SELECT', 'DELETE', 'INSERT' or 'UPDATE'
Variable $type
dbfield::$type in schema-defs.php
Variable $type
database::$type in database-defs.php
Type of database eg: "postgres", "mssql_server"..
Method tables
sqlquery::tables() in query-defs.php
Define table list
Method tidyup
dbquery::tidyup() in query-defs.php
Free resources.
Function transaction_failed
transaction_failed() in query-defs.php
Return DB transaction failure status.
Function transaction_open
transaction_open() in query-defs.php
Return DB transaction open status.
Function transaction_succeeded
transaction_succeeded() in query-defs.php
Return DB transaction success status.
u
top
Variable $unique
dbindex::$unique in schema-defs.php
True if index is unique
Variable $update_action
dbconstraint::$update_action in schema-defs.php
Action to take on update
Variable $user
database::$user in database-defs.php
Default user to connect as
v
top
Variable $valid
maintainer::$valid in maintainer-defs.php
True if this maintainer is good to go
Variable $valid
dbquery::$valid in query-defs.php
True if query is valid, post execution
Variable $view_passwords
maintainer::$view_passwords in maintainer-defs.php
If true, password field content is displayed
Variable $view_pks
maintainer::$view_pks in maintainer-defs.php
If true, primary keys are displayed
Variable $volatile
DB_dbfunction::$volatile in pg-schema-defs.php
Method view_passwords
maintainer::view_passwords() in maintainer-defs.php
Allows content of any password fields to be shown for reference. This is useful to reference screens where someone might need to be able to read passwords from the maintenance screen. Defaults to false.
Method view_primary_keys
maintainer::view_primary_keys() in maintainer-defs.php
Allows primary key values to be viewed along with other data. It is sometimes useful to see this info in view-only mode.
Method view_record_filter
maintainer::view_record_filter() in maintainer-defs.php
Causes the filtering widgets to be viewed or not viewed. The filter widgets allow users to input rudimentary filtering criteria on a single field which they can select, in order to filter the recordset.
w
top
Variable $where
sqlquery::$where in query-defs.php
The query WHERE clause components
Method where
sqlquery::where() in query-defs.php
Add WHERE clause component
a b c d e f g h i j l m n o p q r s t u v w