Database Abstraction Layer for PHP https://adodb.org/dokuwiki/ 2026-04-21T09:11:08+00:00 https://adodb.org/dokuwiki/ https://adodb.org/dokuwiki/lib/exe/fetch.php?media=logo.png text/html 2016-01-13T01:26:00+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:adoschema&rev=1452648360&do=diff adoSchema Syntax object adoSchema( obj $db ) Description Creating an adoSchema object is the first step in processing an XML schema. The only parameter is an ADOdb database connection object, which must already have been created. Example Usage text/html 2016-01-13T01:26:07+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:axmls_functions&rev=1452648367&do=diff AXMLS Function Reference Unlike core ADOdb methods, AXMLS methods that accept boolean arguments, also require that the type of the argument passed be boolean (true/false). Passing an implied boolean value (1/0 or 'value'/'') may cause unexpected results. text/html 2020-01-13T14:52:09+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:axmls_index&rev=1578927129&do=diff ADOdb XML Schema ADOdb-xmlschema See also AXMLS Function Reference The Meta Functions Introduction Adodb-xmlschema, or AXMLS, is a set of classes that extends the ADOdb 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. text/html 2016-01-13T01:26:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:continueonerror&rev=1452648361&do=diff continueOnError Syntax bool continueOnError ( optional bool $mode = NULL ) Description Call this method to enable or disable continuation of SQL execution if an error occurs. If the mode is set to TRUE (continue), AXMLS will continue to apply SQL to the database, even if an error occurs. If the mode is set to FALSE (halt), AXMLS will halt execution of generated sql if an error occurs, though parsing of the schema will continue. text/html 2026-02-13T18:24:45+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:convertschemafile&rev=1771007085&do=diff convertSchemaFile Syntax string ConvertSchemaFile ( string $filename, optional string $newVersion = NULL, optional string $newFile = NULL ) Description Call this method to convert the specified XML schema file to a different AXMLS DTD version. For instance, to convert a schema created for an pre-1.0 version for AXMLS (DTD version 0.1) to a newer version of the DTD (e.g. 0.3). text/html 2026-02-13T18:25:39+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:convertschemastring&rev=1771007139&do=diff convertSchemaString Syntax string convertSchemaString ( string $schema, optional string $newVersion = NULL, optional string $newFile = NULL ) Description Call this method to convert a string containing an XML schema to a different AXMLS DTD version. For instance, to convert a schema created for an pre-1.0 version for AXMLS (DTD version 0.1) to a newer version of the DTD (e.g. 0.3). text/html 2016-01-13T01:26:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:destroy&rev=1452648361&do=diff destroy This method is deprecated and will be removed in ADOdb Version 6: adoSchema now cleans up automatically. == Syntax -- void Destroy () Description Call this method to clean up after an adoSchema object that is no longer in use. text/html 2016-01-13T01:26:02+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:executeinline&rev=1452648362&do=diff executeInline Syntax bool executeInline ( bool $mode = NULL ) Description Call this method to enable or disable inline execution of the schema. If the mode is set to TRUE (inline execution), AXMLS applies the SQL to the database immediately as each schema entity is parsed. text/html 2016-01-13T01:26:08+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:executeschema&rev=1452648368&do=diff executeSchema Syntax integer executeSchema ( optional array $sqlArray = NULL, optional boolean $continueOnErr = NULL ) Description Applies the current XML schema to the database (post execution). Call this method to apply the current schema (generally created by calling text/html 2020-12-30T00:03:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:extractschema&rev=1609286630&do=diff extractSchema See Also parseSchemaFile Syntax string extractSchema ( optional bool $data = false, optional string $indent = ' ', optional string $prefix = '', optional bool $stripprefix = false ) Description Extracts a XML schema from an existing database. text/html 2016-01-13T15:22:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:index&rev=1452698563&do=diff ADOdb XML Schema Pages in this namespace: * ADOdb-xmlschema * adoSchema * AXMLS Function Reference * continueOnError * convertSchemaFile * convertSchemaString * destroy * executeInline * executeSchema * extractSchema * parseSchema * parseSchemaFile * parseSchemaString * printSql * removeSchema * removeSchemaString * saveSql * schemaFileVersion * schemaStringVersion * setPrefix * setUpgradeMethod text/html 2019-12-26T05:44:15+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:parseschema&rev=1577339055&do=diff parseSchema See Also parseSchemaString() parseSchemaFile() executeSchema Syntax array parseSchema ( string $filename, optional bool $returnSchema = FALSE ) Description Loads an XML schema from a file and converts it to SQL. Call this method to load the specified schema from a file (see the DTD for the proper format) and generate the SQL necessary to create the database described by the schema. text/html 2019-12-26T05:50:15+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:parseschemafile&rev=1577339415&do=diff parseSchemaFile See Also parseSchema() parseSchemaString() extractSchema executeSqlArray Syntax array parseSchemaFile ( mixed $filename, optional bool $returnSchema = false ) Loads an XML schema from a file and converts it to SQL. Call this method to load the specified schema from a file (see the DTD for the proper format) and generate the SQL necessary to create the database described by the schema. text/html 2019-12-26T05:36:16+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:parseschemastring&rev=1577338576&do=diff parseSchemaString See Also executeSqlArray Syntax array parseSchemaString ( string $xmlstring, optional bool $returnSchema = FALSE ) Description Converts an XML schema string to SQL. Call this method to parse a string containing an XML schema (see the DTD for the proper format) and generate the SQL necessary to create the database described by the schema. text/html 2026-02-12T15:53:07+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:printsql&rev=1770911587&do=diff printSql Syntax array printSql ( optional string $format = 'NONE' ) Description Returns the last generated current SQL array in printable format. Call this method to fetch the array of SQL queries resulting from ParseSchema() or ParseSchemaString(). The method returns an array of SQL statements or FALSE if an error occurs. The available options are: text/html 2026-02-13T18:23:57+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:removeschema&rev=1771007037&do=diff removeSchema array removeSchema ( string $filename, optional bool $returnSchema=false ) Description Loads an XML schema from a file and converts it to uninstallation SQL. Call this method to load the specified schema (see the DTD for the proper format) from the filesystem and generate the SQL necessary to remove the database described. text/html 2016-01-13T01:26:04+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:removeschemastring&rev=1452648364&do=diff removeSchemaString Syntax array removeSchemaString ( string $schema, optional bool $returnSchema=FALSE ) Description Converts an XML schema string to uninstallation SQL. Call this method to parse a string containing an XML schema (see the DTD for the proper format) and generate the SQL necessary to uninstall the database described by the schema. text/html 2016-01-13T01:26:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:savesql&rev=1452648365&do=diff saveSql boolean saveSql ( optional string $filename = './schema.sql' ) Description Saves the current SQL array to the local filesystem as a list of SQL queries. Call this method to save the array of SQL queries (generally resulting from a parsed XML schema) to the filesystem. The function returns a boolean indicating success or failure of the save text/html 2016-01-13T01:26:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:schemafileversion&rev=1452648365&do=diff schemaFileVersion Syntax string schemaFileVersion ( string $filename ) Description Returns the AXMLS Schema Version of the requested XML schema file. Call this method to obtain the AXMLS DTD version of the requested XML schema file. The method returns the schema version number or FALSE on error text/html 2016-01-13T01:26:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:schemastringversion&rev=1452648365&do=diff schemaStringVersion Syntax string schemaStringVersion ( string $xmlstring ) Description The method returns the AXMLS Schema Version of the provided XML schema string. Call this method to obtain the AXMLS DTD version of the provided XML schema string. text/html 2016-01-13T01:26:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:setprefix&rev=1452648365&do=diff setPrefix Syntax boolean setPrefix ( string $prefix = '' optional bool $addUnderscore=true ) Description Sets a prefix for database objects Call this method to set a standard prefix that will be prepended to all database tables and indexes text/html 2016-01-13T01:26:06+00:00 Anonymous (anonymous@undisclosed.example.com) https://adodb.org/dokuwiki/doku.php?id=v5:axmls:setupgrademethod&rev=1452648366&do=diff setUpgradeMethod Syntax string setUpgradeMethod ( optional string $method = '' ) Description Sets the method to be used for upgrading an existing database Use this method to specify how existing database objects should be upgraded. The method option can be set to one of the following: