• Home
• Postgres

PHP Class Postgres, phppgadmin

Show file Open project: phppgadmin/phppgadmin Class Usage Examples

Public Properties

Property	Type	Description
$_maxNameLen		Max object name length
$_schema		Store the current schema
$codemap		encoding name is the same as its database encoding name.
$defaultprops
$extraTypes		Extra "magic" types. BIGSERIAL was added in PostgreSQL 7.2.
$fkactions		Foreign key stuff. First element MUST be the default.
$fkdeferrable
$fkinitial
$fkmatches
$funcprops		Function properties
$help_base		Default help URL
$help_page		Help sub pages
$id		Name of id column
$joinOps		Supported join operations for use with view wizard
$langmap		Map of internal language name to syntax highlighting name
$major_version
$predefined_size_types		Predefined size types
$privlist		of objects.
$privmap		refer to.
$rule_events		Rule action types
$selectOps		Select operators
$triggerEvents		Array of allowed trigger events
$triggerExecTimes		When to execute the trigger
$triggerFrequency		How often to execute the trigger
$typAlignDef		The default type alignment
$typAligns		Array of allowed type alignments
$typIndexDef		Default index type
$typIndexes		Array of allowed index types
$typStorageDef		The default type storage
$typStorages		Array of allowed type storage attributes

Public Methods

Method	Description
Postgres ( $conn )	Constructor
_encryptPassword ( $username, $password )	Helper function that computes encypted PostgreSQL passwords
_parseACL ( $acl ) : Privileges	Internal function used for parsing ACLs
addCheckConstraint ( $table, $definition, $name = '' )	Adds a check constraint to a table
addColumn ( $table, $column, $type, $array, $length, $notnull, $default, $comment )	Add a new column to a table
addDomainCheckConstraint ( $domain, $definition, $name = '' )	Adds a check constraint to a domain
addForeignKey ( $table, $targschema, $targtable, $sfields, $tfields, $upd_action, $del_action, $match, $deferrable, $initially, $name = '' ) : -1	Adds a foreign key constraint to a table
addGroupMember ( $groname, $user )	Adds a group member
addPrimaryKey ( $table, $fields, $name = '', $tablespace = '' ) : -1	Adds a primary key constraint to a table
addUniqueKey ( $table, $fields, $name = '', $tablespace = '' ) : -1	Adds a unique constraint to a table
alreadyClustered ( $table ) : true	test if a table has been clustered on an index
alterAggregate ( $aggrname, $aggrtype, $aggrowner, $aggrschema, $aggrcomment, $newaggrname, $newaggrowner, $newaggrschema, $newaggrcomment ) : -4	Alters an aggregate
alterColumn ( $table, $column, $name, $notnull, $oldnotnull, $default, $olddefault, $type, $length, $array, $oldtype, $comment ) : -6	Alters a column in a table
alterDatabase ( $dbName, $newName, $newOwner = '', $comment = '' ) : -4	Alters a database the multiple return vals are for postgres 8+ which support more functionality in alter database
alterDatabaseOwner ( string $dbName, string $newOwner ) : integer	Changes ownership of a database This can only be done by a superuser or the owner of the database
alterDatabaseRename ( string $oldName, string $newName ) : integer	Renames a database, note that this operation cannot be performed on a database that is currently being connected to
alterDomain ( $domain, $domdefault, $domnotnull, $domowner ) : -4	Alters a domain
alterSequence ( $sequence, $name, $comment, $owner = null, $schema = null, $increment = null, $minvalue = null, $maxvalue = null, $restartvalue = null, $cachevalue = null, $cycledvalue = null, $startvalue = null ) : -2	Alters a sequence
alterSequenceName ( $seqrs, $name )	Rename a sequence
alterSequenceOwner ( $seqrs, $owner )	Alter a sequence's owner
alterSequenceProps ( $seqrs, $increment, $minvalue, $maxvalue, $restartvalue, $cachevalue, $cycledvalue, $startvalue )	Alter a sequence's properties
alterSequenceSchema ( $seqrs, $schema )	Alter a sequence's schema
alterTable ( $table, $name, $owner, $schema, $comment, $tablespace ) : -2	Alter table properties
alterTableName ( $tblrs, $name = null )	Alter a table's name !\ this function is called from _alterTable which take care of escaping fields
alterTableOwner ( $tblrs, $owner = null )	Alter a table's owner !\ this function is called from _alterTable which take care of escaping fields
alterTableSchema ( $tblrs, $schema = null )	Alter a table's schema !\ this function is called from _alterTable which take care of escaping fields
alterTableTablespace ( $tblrs, $tablespace = null )	Alter a table's tablespace !\ this function is called from _alterTable which take care of escaping fields
alterTablespace ( $spcname, $name, $owner, $comment = '' ) : -4	Alters a tablespace
alterTrigger ( $table, $trigger, $name )	Alters a trigger
alterView ( $view, $name, $owner, $schema, $comment ) : -2	Alter view properties
alterViewName ( $vwrs, $name )	Rename a view
alterViewOwner ( $vwrs, $owner = null )	Alter a view's owner
alterViewSchema ( $vwrs, $schema )	Alter a view's schema
analyzeDB ( $table = '' )	Analyze a database
arrayClean ( &$arr ) : The	Cleans (escapes) an array
beginDump ( )	Sets up the data object for a dump. eg. Starts the appropriate transaction, sets variables, etc.
browseQuery ( $type, $table, $query, $sortkey, $sortdir, $page, $page_size, &$max_pages ) : -5	Returns a recordset of all columns in a query. Supports paging.
browseQueryCount ( $query, $count ) : -1	Finds the number of rows that would be returned by a query.
browseRow ( $table, $key ) : A	Returns a recordset of all columns in a table
changeAggregateOwner ( $aggrname, $aggrtype, $newaggrowner )	Changes the owner of an aggregate function
changeAggregateSchema ( $aggrname, $aggrtype, $newaggrschema )	Changes the schema of an aggregate function
changeFtsMapping ( $ftscfg, array $mapping, string $action, string $dictname = null )	Creates/updates/deletes FTS mapping.
changePassword ( $rolename, $password )	Changes a role's password
clean ( &$str ) : The	Cleans (escapes) a string
clusterIndex ( $table = '', $index = '' )	Clusters an index
createAggregate ( $name, $basetype, $sfunc, $stype, $ffunc, $initcond, $sortop, $comment ) : -1	Creates a new aggregate in the database
createCompositeType ( $name, $fields, $field, $type, $array, $length, $colcomment, $typcomment ) : -1	Creates a new composite type in the database
createDatabase ( $database, $encoding, $tablespace = '', $comment = '', $template = 'template1', $lc_collate = '', $lc_ctype = '' ) : -2	Creates a database
createDomain ( $domain, $type, $length, $array, $notnull, $default, $check )	Creates a domain
createEnumType ( $name, $values, $typcomment ) : -2	Creates a new enum type in the database
createFtsConfiguration ( string $cfgname, string $parser = '', string $template = '', string $comment = '' )	Creates a new FTS configuration.
createFtsDictionary ( string $dictname, boolean $isTemplate = false, string $template = '', string $lexize = '', string $init = '', string $option = '', string $comment = '' )	Creates a new FTS dictionary or FTS dictionary template.
createFunction ( $funcname, $args, $returns, $definition, $language, $flags, $setof, $cost, $rows, $comment, $replace = false ) : -4	Creates a new function.
createGroup ( $groname, $users )	Creates a new group
createIndex ( $name, $table, $columns, $type, $unique, $where, $tablespace, $concurrently )	Creates an index
createRole ( $rolename, $password, $superuser, $createdb, $createrole, $inherits, $login, $connlimit, $expiry, $memberof, $members, $adminmembers )	Creates a new role
createRule ( $name, $event, $table, $where, $instead, $type, $action, $replace = false ) : -1	Creates a rule
createSchema ( $schemaname, $authorization = '', $comment = '' )	Creates a new schema.
createSequence ( $sequence, $increment, $minvalue, $maxvalue, $startvalue, $cachevalue, $cycledvalue )	Creates a new sequence
createTable ( $name, $fields, $field, $type, $array, $length, $notnull, $default, $withoutoids, $colcomment, $tblcomment, $tablespace, $uniquekey, $primarykey ) : -1	Creates a new table in the database
createTableLike ( $name, $like, $defaults = false, $constraints = false, $idx = false, $tablespace = '' )	Creates a new table in the database copying attribs and other properties from another table
createTablespace ( $spcname, $spcowner, $spcloc, $comment = '' )	Creates a tablespace
createTrigger ( $tgname, $table, $tgproc, $tgtime, $tgevent, $tgfrequency, $tgargs )	Creates a trigger
createType ( $typname, $typin, $typout, $typlen, $typdef, $typelem, $typdelim, $typbyval, $typalign, $typstorage )	Creates a new type
createUser ( $username, $password, $createdb, $createuser, $expiry, $groups )	Creates a new user
createView ( $viewname, $definition, $replace, $comment )	Creates a new view.
dbBool ( &$parameter )	Change the value of a parameter to 't' or 'f' depending on whether it evaluates to true or false
deleteRow ( $table, $key, $schema = false )	Delete a row from a table
disableTrigger ( $tgname, $table )	Disables a trigger
dropAggregate ( $aggrname, $aggrtype, $cascade )	Removes an aggregate function from the database
dropAutovacuum ( $table )
dropCheckConstraint ( $table, $name ) : -4	Drops a check constraint from a table
dropColumn ( $table, $column, $cascade )	Drops a column from a table
dropColumnDefault ( $table, $column )	Drops default value of a column
dropConstraint ( $constraint, $relation, $type, $cascade )	Removes a constraint from a relation
dropDatabase ( $database )	Drops a database
dropDomain ( $domain, $cascade )	Drops a domain.
dropDomainConstraint ( $domain, $constraint, $cascade )	Drops a domain constraint
dropFtsConfiguration ( $ftscfg, $cascade )	Drops FTS coniguration
dropFtsDictionary ( $ftsdict, $cascade )	Drops FTS dictionary
dropFunction ( $function_oid, $cascade )	Drops a function.
dropGroup ( $groname )	Removes a group
dropGroupMember ( $groname, $user )	Removes a group member
dropIndex ( $index, $cascade )	Removes an index from the database
dropOperator ( $operator_oid, $cascade )	Drops an operator
dropRole ( $rolename )	Removes a role
dropRule ( $rule, $relation, $cascade )	Removes a rule from a table OR view
dropSchema ( $schemaname, $cascade )	Drops a schema.
dropSequence ( $sequence, $cascade )	Drops a given sequence
dropTable ( $table, $cascade )	Removes a table from the database
dropTablespace ( $spcname )	Drops a tablespace
dropTrigger ( $tgname, $table, $cascade )	Drops a trigger
dropType ( $typname, $cascade )	Drops a type.
dropUser ( $username )	Removes a user
dropView ( $viewname, $cascade )	Drops a view.
dumpRelation ( $relation, $oids ) : -1	Returns a recordset of all columns in a relation. Used for data export.
editRow ( $table, $vars, $nulls, $format, $types, $keyarr ) : -1	Updates a row in a table
emptyTable ( $table )	Empties a table in the database
enableTrigger ( $tgname, $table )	Enables a trigger
endDump ( )	Ends the data object for a dump.
escapeBytea ( $data ) : Data	Escapes bytea data for display on the screen
executeScript ( $name, $callback = null ) : True	Executes an SQL script as a series of SQL statements. Returns the result of the final step. This is a very complicated lexer based on the REL7_4_STABLE src/bin/psql/mainloop.c lexer in the PostgreSQL source code.
fieldArrayClean ( &$arr ) : The	Cleans (escapes) an array of field names
fieldClean ( &$str ) : The	Cleans (escapes) an object name (eg. table, field)
findObject ( $term, $filter ) : A	Searches all system catalogs to find objects that match a certain name.
formatType ( $typname, $typmod )	Formats a type correctly for display. Postgres 7.0 had no 'format_type' built-in function, and hence we need to do it manually.
formatValue ( $type, $format, $value ) : The	Formats a value or expression for sql purposes
getAggregate ( $name, $basetype ) : A	Gets all information for an aggregate
getAggregates ( ) : A	Gets all aggregates
getAttributeNames ( $table, $atts ) : -2	Given an array of attnums and a relation, returns an array mapping attribute number to attribute name.
getAutovacuum ( ) : associative	Returns all autovacuum global configuration
getCasts ( ) : All	Returns a list of all casts in the database
getChangeUserSQL ( $user ) : The	Returns the SQL for changing the current user
getConstraints ( $table ) : A	Returns a list of all constraints on a table
getConstraintsWithFields ( $table ) : a	Returns a list of all constraints on a table, including constraint name, definition, related col and referenced namespace, table and col if needed
getConversions ( ) : All	Returns a list of all conversions in the database
getDatabase ( $database ) : The	Return all information about a particular database
getDatabaseComment ( string $database ) : recordset	Return the database comment of a db from the shared description table
getDatabaseEncoding ( ) : The	Returns the current database encoding
getDatabaseOwner ( string $database ) : recordset	Return the database owner of a db
getDatabases ( $currentdatabase = NULL ) : A	Return all database available on the server
getDefaultWithOid ( ) : default_with_oids	Returns the current default_with_oids setting
getDomain ( $domain ) : A	Gets all information for a single domain
getDomainConstraints ( $domain ) : A	Get domain constraints
getDomains ( ) : All	Return all domains in current schema. Excludes domain constraints.
getEnumValues ( $name ) : A	Get defined values for a given enum
getFtsConfigurationByName ( $ftscfg ) : FTS	Return all information related to a FTS configuration
getFtsConfigurationMap ( string $ftscfg ) : RecordSet	Returns the map of FTS configuration given (list of mappings (tokens) and their processing dictionaries)
getFtsConfigurations ( $all = true ) : A	Returns available FTS configurations
getFtsDictionaries ( $all = true )	Returns FTS dictionaries available
getFtsDictionaryByName ( $ftsdict ) : RecordSet	Return all information relating to a FTS dictionary
getFtsDictionaryTemplates ( )	Returns all FTS dictionary templates available
getFtsMappingByName ( $ftscfg, $mapping ) : FTS	Return all information related to a given FTS configuration's mapping
getFtsMappings ( $ftscfg )	Return list of FTS mappings possible for given parser (specified by given configuration since configuration can only have 1 parser)
getFtsParsers ( $all = true ) : RecordSet	Returns FTS parsers available
getFunction ( $function_oid ) : Function	Returns all details for a particular function
getFunctionProperties ( $f ) : An	Returns an array containing a function's properties
getFunctions ( $all = false, $type = null ) : All	Returns a list of all functions in the database
getGroup ( $groname ) : All	Return users in a specific group
getGroups ( ) : All	Returns all groups in the database cluser
getHelp ( $help )	Fetch a URL (or array of URLs) for a given help page.
getHelpPages ( )
getIndexes ( $table = '', $unique = false ) : A	Grabs a list of indexes for a table
getLanguages ( $all = false ) : A	Gets all languages
getLinkingKeys ( $tables ) : -1	A function for getting all columns linked by foreign keys given a group of tables
getLocks ( ) : A	Returns table locks information in the current database
getMemberOf ( $rolename ) : All	Returns all role names which the role belongs to
getMembers ( $rolename, $admin = 'f' ) : All	Returns all role names that are members of a role
getOpClasses ( ) : A	Gets all opclasses
getOperator ( $operator_oid ) : Function	Returns all details for a particular operator
getOperators ( ) : All	Returns a list of all operators in the database
getPreparedXacts ( $database = null ) : A	Returns prepared transactions information
getPrivileges ( $object, $type, $table = null ) : -3	Grabs an array of users and their privileges for an object, given its type.
getProcesses ( $database = null ) : A	Returns all available process information.
getReferrers ( $table ) : A	Finds the foreign keys that refer to the specified table
getRole ( $rolename ) : The	Returns information about a single role
getRoles ( $rolename = '' ) : All	Returns all roles in the database cluster
getRowIdentifier ( $table ) : -1	Get the fields for uniquely identifying a row in a table
getRules ( $table ) : A	Returns a list of all rules on a table OR view
getSchemaByName ( $schema ) : Schema	Return all information relating to a schema
getSchemas ( ) : All	Return all schemas in the current database.
getSearchPath ( ) : Array	Return the current schema search path
getSelectSQL ( $table, $show, $values, $ops, $orderby = [] ) : The	Generates the SQL for the 'select' function
getSequence ( $sequence ) : A	Returns properties of a single sequence
getSequences ( $all = false ) : A	Returns all sequences in the current database
getStatsDatabase ( $database ) : A	Fetches statistics for a database
getStatsIndexIO ( $table ) : A	Fetches I/0 statistics for all indexes on a table
getStatsIndexTuples ( $table ) : A	Fetches tuple statistics for all indexes on a table
getStatsTableIO ( $table ) : A	Fetches I/0 statistics for a table
getStatsTableTuples ( $table ) : A	Fetches tuple statistics for a table
getTable ( $table ) : A	Returns table information
getTableAttributes ( $table, $field = '' ) : All	Retrieve the attribute definition of a table
getTableAutovacuum ( $table = '' ) : A	Returns all available autovacuum per table information.
getTableChildren ( $table ) : A	Finds the names and schemas of child tables
getTableDefPrefix ( $table, $clean = false ) : null	Returns the SQL definition for the table.
getTableDefSuffix ( $table ) : null	Returns extra table definition information that is most usefully dumped after the table contents for speed and efficiency reasons
getTableParents ( $table ) : A	Finds the names and schemas of parent tables (in order)
getTables ( $all = false ) : All	Return all tables in current database (and schema)
getTablespace ( $spcname ) : A	Retrieves a tablespace's information
getTablespaces ( $all = false ) : A	Retrieves information for all tablespaces
getTrigger ( $table, $trigger ) : A	Grabs a single trigger
getTriggerDef ( $trigger ) : The	A helper function for getTriggers that translates an array of attribute numbers to an array of field names.
getTriggerFunctions ( )	Returns a list of all functions that can be used in triggers
getTriggers ( $table = '' ) : A	Grabs a list of triggers on a table
getType ( $typname ) : Type	Returns all details for a particular type
getTypes ( $all = false, $tabletypes = false, $domains = false ) : A	Returns a list of all types in the database
getUser ( $username ) : The	Returns information about a single user
getUsers ( ) : All	Returns all users in the database cluster
getVariables ( ) : A	Returns all available variable information.
getView ( $view ) : View	Returns all details for a particular view
getViews ( ) : All	Returns a list of all views in the database
grantRole ( $role, $rolename, $admin )	Grants membership in a role
hasAggregateSortOp ( )	Capabilities
hasAlterAggregate ( )
hasAlterColumnType ( )
hasAlterDatabase ( )
hasAlterDatabaseOwner ( )
hasAlterDatabaseRename ( )
hasAlterDomains ( )
hasAlterSchema ( )
hasAlterSchemaOwner ( )
hasAlterSequenceSchema ( )
hasAlterSequenceStart ( )
hasAlterTableSchema ( )
hasAutovacuum ( )
hasByteaHexDefault ( )
hasConcurrentIndexBuild ( )
hasCreateFieldWithConstraints ( )
hasCreateTableLike ( )
hasCreateTableLikeWithConstraints ( )
hasCreateTableLikeWithIndexes ( )
hasDatabaseCollation ( )
hasDisableTriggers ( )
hasDomainConstraints ( )
hasEnumTypes ( )
hasFTS ( )
hasForceReindex ( )
hasFunctionAlterOwner ( )
hasFunctionAlterSchema ( )
hasFunctionCosting ( )
hasFunctionGUC ( )
hasGrantOption ( )
hasMagicTypes ( )
hasNamedParams ( )
hasObjectID ( $table ) : null	Checks to see whether or not a table has a unique id column
hasPrepare ( )
hasPreparedXacts ( )
hasQueryCancel ( )
hasQueryKill ( )
hasReadOnlyQueries ( )
hasRecluster ( )
hasRoles ( )
hasServerAdminFuncs ( )
hasSharedComments ( )
hasTablespaces ( )
hasUserRename ( )
hasUserSignals ( )
hasVirtualTransactionId ( )
insertRow ( $table, $fields, $values, $nulls, $format, $types ) : -1	Adds a new row to a table
isSuperUser ( $username = '' ) : True	Determines whether or not a user is a super user
nextvalSequence ( $sequence ) : -1	Execute nextval on a given sequence
phpBool ( $parameter )	Change a parameter from 't' or 'f' to a boolean, (others evaluate to false)
printField ( $name, $value, $type, $extras = [] )	Outputs the HTML code for a particular field
reindex ( $type, $name, $force = false )	Rebuild indexes
renameAggregate ( $aggrschema, $aggrname, $aggrtype, $newaggrname )	Renames an aggregate function
renameColumn ( $table, $column, $newName )	Renames a column in a table
renameRole ( $rolename, $newrolename )	Renames a role
renameUser ( $username, $newname )	Renames a user
resetSequence ( $sequence ) : -1	Resets a given sequence to min value of sequence
restartSequence ( $sequence ) : -1	Restart a given sequence to its start value
revokeRole ( $role, $rolename, $admin, $type = 'RESTRICT' )	Revokes membership in a role
saveAutovacuum ( $table, $vacenabled, $vacthreshold, $vacscalefactor, $anathresold, $anascalefactor, $vaccostdelay, $vaccostlimit ) : A	Returns all available autovacuum per table information.
sendSignal ( $pid, $signal ) : -1	Sends a cancel or kill command to a process
setColumnDefault ( $table, $column, $default )	Sets default value of a column
setColumnNull ( $table, $column, $state )	Sets whether or not a column can contain NULLs
setComment ( $obj_type, $obj_name, $table, $comment, $basetype = NULL )	Sets the comment for an object in the database
setFunction ( $function_oid, $funcname, $newname, $args, $returns, $definition, $language, $flags, $setof, $funcown, $newown, $funcschema, $newschema, $cost, $rows, $comment ) : -7	Updates (replaces) a function.
setPrivileges ( $mode, $type, $object, $public, $usernames, $groupnames, $privileges, $grantoption, $cascade, $table ) : -4	Grants a privilege to a user, group or public
setRenameRole ( $rolename, $password, $superuser, $createdb, $createrole, $inherits, $login, $connlimit, $expiry, $memberof, $members, $adminmembers, $memberofold, $membersold, $adminmembersold, $newrolename ) : -3	Adjusts a role's info and renames it
setRenameUser ( $username, $password, $createdb, $createuser, $expiry, $newname ) : -3	Adjusts a user's info and renames the user
setRole ( $rolename, $password, $superuser, $createdb, $createrole, $inherits, $login, $connlimit, $expiry, $memberof, $members, $adminmembers, $memberofold, $membersold, $adminmembersold )	Adjusts a role's info
setRule ( $name, $event, $table, $where, $instead, $type, $action ) : -1	Edits a rule on a table OR view
setSchema ( $schema )	Sets the current working schema. Will also set Class variable.
setSearchPath ( $paths ) : -2	Sets the current schema search path
setUser ( $username, $password, $createdb, $createuser, $expiry )	Adjusts a user's info
setView ( $viewname, $definition, $comment ) : -3	Updates a view.
setvalSequence ( $sequence, $nextvalue ) : -1	Execute setval on a given sequence
updateFtsConfiguration ( $cfgname, $comment, $name )	Alters FTS configuration
updateFtsDictionary ( $dictname, $comment, $name )	Alters FTS dictionary or dictionary template
updateSchema ( $schemaname, $comment, $name, $owner )	Updates a schema.
vacuumDB ( $table = '', $analyze = false, $full = false, $freeze = false )	Vacuums a database

Protected Methods

Method	Description
_alterSequence ( $seqrs, $name, $comment, $owner, $schema, $increment, $minvalue, $maxvalue, $restartvalue, $cachevalue, $cycledvalue, $startvalue ) : -7	Protected method which alter a sequence SHOULDN'T BE CALLED OUTSIDE OF A TRANSACTION
_alterTable ( $tblrs, $name, $owner, $schema, $comment, $tablespace ) : -7	Protected method which alter a table SHOULDN'T BE CALLED OUTSIDE OF A TRANSACTION
_alterView ( $vwrs, $name, $owner, $schema, $comment ) : -6	Protected method which alter a view SHOULDN'T BE CALLED OUTSIDE OF A TRANSACTION

Private Methods

Method	Description
advance_1 ( &$i, &$prevlen, &$thislen )	A private helper method for executeScript that advances the character by 1. In psql this is careful to take into account multibyte languages, but we don't at the moment, so this function is someone redundant, since it will always advance by 1
valid_dolquote ( $dquote ) : True	Private helper method to detect a valid $foo$ quote delimiter at the start of the parameter dquote

Method Details

Property Details