Database Abstraction Layer for PHP http://adodb.org/dokuwiki/ 2026-05-16T21:38:27+00:00 http://adodb.org/dokuwiki/ http://adodb.org/dokuwiki/lib/exe/fetch.php?media=logo.png text/html 2021-01-18T02:45:57+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:actualtype&rev=1610937957&do=diff actualType See Also metaType() Syntax string actualType( string $metaType ) Description The method actualType() returns the database specific data type for a given metaType. The returned values varies from one database to another. The function returns information about both standard and custom metatypes. text/html 2016-01-13T01:06:30+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:addcolumnsql&rev=1452647190&do=diff addColumnSql See Also Column Attributes Reference Syntax array addColumnSql( string $tableName, string $columnData ) Description The method addColumnSql() creates the SQL statement necessary to add one or more columns to an existing table, given by $tableName text/html 2023-05-20T15:50:31+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:adofieldobject&rev=1684597831&do=diff adoFieldObject Description When the metaColumns method is executed by ADOdb, the data retrieved is placed in an array of adoFieldObjects. This is a class based around the following format: class ADOFieldObject { var $name = ''; var $max_length = 0; var $type=""; } text/html 2016-01-13T01:06:29+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:altercolumnsql&rev=1452647189&do=diff alterColumnSql Add usage example, expand description of new table requirement See Also Column Attributes Reference Syntax array alterColumnSql( string $tableName, string $columnData, optional string $tableFields='', optional string $tableOptions='' ) Description text/html 2025-08-17T00:04:13+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:changetablesql&rev=1755389053&do=diff changeTableSql See Also Column Attributes Reference executeSqlArray() Syntax array changeTableSql ( string $tableName, string $fields, optional array $tableOptions=false, optional bool $dropColumns=false ) Description The method changeTableSql() creates the SQL statement necessary to make basic changes to a table in the database and populates it with columns defined in text/html 2024-08-31T14:26:01+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:column_attributes&rev=1725114361&do=diff Dictionary Column Attributes Description When creating a column in a table using the dictionary methods, the information provided must conform to the following specification. Each column created has a number of mandatory and optional parameters. Basic Syntax text/html 2026-03-22T22:45:50+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:comments&rev=1774219550&do=diff Adding Comments To Tables Database support for adding comments varies from full support (IBM DB2, PostgreSQL) to none (SQLite) with differing implementation methods. Databases that support it do it via 1 of 2 methods, Either be adding the comment as part of the table creation and modification process, or by adding a comment to a previously created table. In addition, databases have varying levels of support for adding comments to tables, columns and indexes. The following matrix shows available… text/html 2018-07-01T20:42:06+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:createdatabase&rev=1530477726&do=diff createDatabase Syntax string createDatabase( string $databaseName, optional mixed $databaseOptions=false ) Description The method createDatabase() returns an array of strings holding the SQL necessary to create a database (or user space) on the current DBMS. To actually execute the code, the output must be passes to text/html 2016-01-13T01:06:30+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:createindexsql&rev=1452647190&do=diff createIndexSql Syntax array createIndexSql( string $indexName, string $tableName, mixed $indexColumns, optional mixed $indexOptions=false ) Description The method createIndexSql() creates the SQL statement necessary to create an index, given by text/html 2016-03-05T00:55:04+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:createtablesql&rev=1457139304&do=diff createTableSql See Also Column Attributes Reference executeSqlArray() Syntax array createTableSql ( string $tableName, string $fields, optional array $tableOptions ) Description The method createTableSql() creates the SQL statement necessary to create a table in the database and populates it with columns defined in text/html 2025-07-19T00:40:33+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:dictionary_index&rev=1752885633&do=diff Data Dictionary The Data Dictionary Introduction The Data Dictionary provides a series of 'Meta-Functions' that allow a portable method of managing the schema of databases, from simple querying of data attributes of columns to XML based routines to build and manage new tables. text/html 2016-01-13T01:06:30+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:dropcolumnsql&rev=1452647190&do=diff dropColumnSql See Also Column Attributes Reference Syntax array dropColumnSql( string $tableName, string $columnName ) Description The method dropColumnSql() creates the SQL statement necessary to drop an existing column given by $columnName from an existing table, given by ''$tableName'. text/html 2016-01-13T01:06:30+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:dropindexsql&rev=1452647190&do=diff dropIndexSql Syntax array dropIndexSql( string $indexName, optional string $tableName=null, ) Description The method dropIndexSql() creates the SQL statement necessary to drop an index, given by $indexName on an existing table, optionally given by text/html 2016-01-13T01:06:28+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:droptablesql&rev=1452647188&do=diff dropTableSql See Also executeSqlArray() Syntax array dropTableSql ( string $tableName ) Description The method dropTableSql() creates the SQL statement necessary to drop an existing table in the database. In order to actualy drop the table, the output of the command must be executed with the text/html 2016-01-13T01:06:26+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:executesqlarray&rev=1452647186&do=diff executeSqlArray Syntax bool executeSqlArray ( array $sqlStatements ) Description The method executeSqlArray() executes an array of statements constructed by one of the data dictionary functions such as createTableSql(), dropIndexSql() or addColumnSql(). The statements are executed within the scope of a single transaction. text/html 2017-05-13T22:23:16+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:getactualtype&rev=1494714196&do=diff getActualType Is a pseudonym of actualType(). text/html 2017-07-22T16:10:15+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:getcommentsql&rev=1500739815&do=diff getCommentSql Note that this function is currently only supported on Oracle databases Syntax string getCommentSql( string $tableName, string $columnName ) Description The method getCommentSql() returns a string containing the SQL necessary to read the column comments from a table, if the database supports it. text/html 2016-01-13T01:06:31+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:gettablecasing&rev=1452647191&do=diff getTableCasing See Also setTableCasing() Syntax From ADOdb 6.0 * int getTableCasing() * This feature is supported in the IBM DB2 driver from version 5.21.0 Description getTableCasing() is a helper method that returns the currently set table casing value. text/html 2016-01-13T03:01:57+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:index&rev=1452654117&do=diff Data Dictionary Pages in this namespace: * actualType * addColumnSql * Adding Comments To Tables * ADOdb-xmlschema * adoFieldObject * alterColumnSql * changeTableSql * createDatabase * createIndexSql * createTableSql * Dictionary Column Attributes * dropColumnSql * dropIndexSql * dropTableSql * executeSqlArray * getActualType * getCommentSql * getTableCasing * metaColumnNames * metaColumns * metaDatabases * metaForeignKeys * metaIndexes * metaPrimaryKeys * metaProced… text/html 2016-02-24T17:24:27+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:metacolumnnames&rev=1456334667&do=diff metaColumnNames Syntax string[] metaColumnNames( string $tableName, optional bool $numericIndices=false, optional bool $usePostgresAttnum=false ) Description The function metaColumnNames() accepts a string parameter, a table name in the database that is currently attached, and returns either an associative array of the columns in the table, or a numeric array based on the value of text/html 2018-07-01T20:18:38+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:metacolumns&rev=1530476318&do=diff metaColumns obj[] metaColumns( string $tableName, optional bool $normalize=false ) Description The function metaColumns() returns an array of adoFieldObject objects, each representing a description of each field of the requested table or view in the passed value text/html 2026-02-18T02:51:55+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:metadatabases&rev=1771383115&do=diff metaDatabases Syntax mixed metaDataBases(){} Description The function metaDatabases() returns a list of the databases visible to the connected user. If the driver does not support the command then it returns false. Visibility of a database does not assume any rights are available to the connected user. text/html 2026-02-25T23:40:20+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:metaforeignkeys&rev=1772062820&do=diff metaForeignKeys Syntax mixed metaForeignKeys( string $tableName, optional string $owner='', optional bool $upperCase=false, optional bool $associative=false ) Description The function metaForeignKeys() returns an array of the foreign keys associated with a specific table. If there are no foreign keys then the function returns false. text/html 2026-02-20T03:53:08+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:metaindexes&rev=1771559588&do=diff metaIndexes See Also metaPrimaryKeys() Syntax mixed metaIndexes( string $tableName, optional bool $includePrimary=false, optional string $owner=false, ) Description The function metaIndexes() returns a list of indexes associated with a specific table. If there are no indices defined for the requested table, the method returns false. text/html 2026-02-20T16:20:24+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:metaprimarykeys&rev=1771604424&do=diff metaPrimaryKeys See Also metaIndexes() Syntax mixed metaPrimaryKeys( string $tableName, optional string $owner=false, ) Description The function metaPrimaryKeys() returns the column names in the primary key associated with a specific table as a numeric array. If there are no primary keys, then the function returns false. text/html 2026-03-24T01:50:39+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:metaprocedures&rev=1774317039&do=diff metaProcedures See Also prepareSp Syntax function metaProcedures( optional string $namePattern=null, optional string $catalog=null, optional string $schemaPattern=null ) Description The function metaProcedures() returns a list of stored procedures in a database. Some databases do not support stored procedures. The function returns an array or false if the database does not support stored procedures or there are currently no stored procedures. text/html 2025-08-29T12:32:29+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:metatables&rev=1756470749&do=diff metaTables Syntax string[] metaTables( optional string $tableType=false, optional bool $showSchema=false, optional string $mask=false, optional string $schemaMask=false ) Description The function metaTables() returns a list of tables and views in the currently attached database. The function does not return system tables. text/html 2016-01-19T17:51:44+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:metatransaction&rev=1453225904&do=diff metaTransaction See Also setTransactionMode() Syntax string metaTransaction( string $transactionLevel, string $dataProvider ) Description The method metaTransaction() returns a database specific isolation level statement for a supplied database and meta transaction level. text/html 2021-03-09T09:41:21+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:metatype&rev=1615282881&do=diff metaType Syntax string metaType( mixed $dataType ) Description The function metaType() accepts as an argument a native, database-specific type. This is usually the result of a call to fetchField(), and can be given either as a string, or an ADOFieldObject. text/html 2016-01-13T01:06:28+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:renamecolumnsql&rev=1452647188&do=diff renameColumnSql See Also Column Attributes Reference Syntax array renameColumnSql( string $tableName, string $oldColumnName, string $newColumnName, optional string $columnSpec='' ) Description The method renameColumnSql() creates the SQL statement necessary to rename an existing column name given by text/html 2016-01-13T01:06:30+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:renametablesql&rev=1452647190&do=diff renameTableSql See Also executeSqlArray() Syntax array renameTableSql ( string $oldTableName, string $newTableName ) Description The method renameTableSql() creates the SQL statement necessary to rename an existing table in the database. In order to actualy rename the table, the output of the command must be executed with the text/html 2017-07-22T16:39:30+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:setactualtype&rev=1500741570&do=diff setActualType From ABOdb V5.21 See Also getActualType() metaType() Syntax bool setActualType( string $metaType, string $actualType, optional bool $newType ) Description The method setActualType() either modifies the database specific data type for a given text/html 2021-03-03T12:42:56+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:setcommentsql&rev=1614775376&do=diff setCommentSql Syntax string setCommentSql( string $tableName, string $columnName, string $comment ) Description The method setCommentSql() returns a string containing the SQL necessary to set the column comments on a table to the specified value, if the database supports it. text/html 2016-01-13T01:06:31+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:settablecasing&rev=1452647191&do=diff setTableCasing See Also getTableCasing() Syntax From ADOdb 6.0 * void setTableCasing( int $caseOption ) * This feature is supported in the IBM DB2 driver from version 5.21.0 Description setTableCasing() is a helper method that automatically converts any text/html 2018-06-11T08:05:23+00:00 Anonymous (anonymous@undisclosed.example.com) http://adodb.org/dokuwiki/doku.php?id=v5:dictionary:xmlschema&rev=1528704323&do=diff ADOdb-xmlschema See also AXMLS Function Reference The Meta Functions Introduction Adodb-xmlschema, or AXMLS, is a set of classes that extends the ADOdb The Data Dictionary by processing XML formatted files and transforming them into ADOdb portable schema management commands. In simple terms: * An XML file contains all of the definitions required to create a table, the associated columns, indexes and constraints.