diff options
Diffstat (limited to 'doc/html/tqsqldatabase.html')
| -rw-r--r-- | doc/html/tqsqldatabase.html | 74 |
1 files changed, 37 insertions, 37 deletions
diff --git a/doc/html/tqsqldatabase.html b/doc/html/tqsqldatabase.html index 57846d91d..492a542d4 100644 --- a/doc/html/tqsqldatabase.html +++ b/doc/html/tqsqldatabase.html @@ -117,7 +117,7 @@ for executing and manipulating SQL queries (see <a href="tqsqlquery.html">TQSqlQ <p>See also <a href="database.html">Database Classes</a>. <hr><h2>Member Function Documentation</h2> -<h3 class=fn><a name="TQSqlDatabase"></a>TQSqlDatabase::TQSqlDatabase ( const <a href="ntqstring.html">TQString</a> & type, const <a href="ntqstring.html">TQString</a> & name, <a href="tqobject.html">TQObject</a> * parent = 0, const char * objname = 0 )<tt> [protected]</tt> +<h3 class=fn><a name="TQSqlDatabase"></a>TQSqlDatabase::TQSqlDatabase ( const <a href="tqstring.html">TQString</a> & type, const <a href="tqstring.html">TQString</a> & name, <a href="tqobject.html">TQObject</a> * parent = 0, const char * objname = 0 )<tt> [protected]</tt> </h3> Creates a TQSqlDatabase connection called <em>name</em> that uses the driver referred to by <em>type</em>, with the parent <em>parent</em> and the @@ -151,7 +151,7 @@ so it should not be deleted. </h3> Destroys the object and frees any allocated resources. -<h3 class=fn><a href="tqsqldatabase.html">TQSqlDatabase</a> * <a name="addDatabase"></a>TQSqlDatabase::addDatabase ( const <a href="ntqstring.html">TQString</a> & type, const <a href="ntqstring.html">TQString</a> & connectionName = defaultConnection )<tt> [static]</tt> +<h3 class=fn><a href="tqsqldatabase.html">TQSqlDatabase</a> * <a name="addDatabase"></a>TQSqlDatabase::addDatabase ( const <a href="tqstring.html">TQString</a> & type, const <a href="tqstring.html">TQString</a> & connectionName = defaultConnection )<tt> [static]</tt> </h3> Adds a database to the list of database connections using the driver <em>type</em> and the connection name <em>connectionName</em>. @@ -171,7 +171,7 @@ than once without specifying <em>connectionName</em>. <p> <p>See also <a href="#database">database</a>() and <a href="#removeDatabase">removeDatabase</a>(). <p>Examples: <a href="sql.html#x2141">sql/overview/connect1/main.cpp</a>, <a href="sql.html#x2147">sql/overview/connection.cpp</a>, and <a href="sqltable-example.html#x2454">sql/sqltable/main.cpp</a>. -<h3 class=fn><a href="tqsqldatabase.html">TQSqlDatabase</a> * <a name="addDatabase-2"></a>TQSqlDatabase::addDatabase ( <a href="tqsqldriver.html">TQSqlDriver</a> * driver, const <a href="ntqstring.html">TQString</a> & connectionName = defaultConnection )<tt> [static]</tt> +<h3 class=fn><a href="tqsqldatabase.html">TQSqlDatabase</a> * <a name="addDatabase-2"></a>TQSqlDatabase::addDatabase ( <a href="tqsqldriver.html">TQSqlDriver</a> * driver, const <a href="tqstring.html">TQString</a> & connectionName = defaultConnection )<tt> [static]</tt> </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> This function is useful if you need to set up the database connection and instantiate the driver yourself. If you do this, it @@ -246,7 +246,7 @@ an overview of the drivers and their constructor arguments. <tr bgcolor="#d0d0d0"> <td valign="top"><a href="sql-driver.html#TQTDS7">TQTDS7</a> <td valign="top">TQTDSDriver -<td valign="top">LOGINREC* loginRecord, DBPROCESS* dbProcess, const <a href="ntqstring.html">TQString</a>& hostName +<td valign="top">LOGINREC* loginRecord, DBPROCESS* dbProcess, const <a href="tqstring.html">TQString</a>& hostName <td valign="top"><tt>tqsql_tds.cpp</tt> <tr bgcolor="#f0f0f0"> <td valign="top"><a href="sql-driver.html#TQSQLITE">TQSQLITE</a> @@ -281,14 +281,14 @@ transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. <p> <p>See also <a href="tqsqldriver.html#hasFeature">TQSqlDriver::hasFeature</a>() and <a href="#rollback">rollback</a>(). -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="connectOptions"></a>TQSqlDatabase::connectOptions () const +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="connectOptions"></a>TQSqlDatabase::connectOptions () const </h3><p>Returns the database connect options. See the <a href="tqsqldatabase.html#connectOptions-prop">"connectOptions"</a> property for details. -<h3 class=fn>bool <a name="contains"></a>TQSqlDatabase::contains ( const <a href="ntqstring.html">TQString</a> & connectionName = defaultConnection )<tt> [static]</tt> +<h3 class=fn>bool <a name="contains"></a>TQSqlDatabase::contains ( const <a href="tqstring.html">TQString</a> & connectionName = defaultConnection )<tt> [static]</tt> </h3> Returns TRUE if the list of database connections contains <em>connectionName</em>; otherwise returns FALSE. -<h3 class=fn><a href="tqsqldatabase.html">TQSqlDatabase</a> * <a name="database"></a>TQSqlDatabase::database ( const <a href="ntqstring.html">TQString</a> & connectionName = defaultConnection, bool open = TRUE )<tt> [static]</tt> +<h3 class=fn><a href="tqsqldatabase.html">TQSqlDatabase</a> * <a name="database"></a>TQSqlDatabase::database ( const <a href="tqstring.html">TQString</a> & connectionName = defaultConnection, bool open = TRUE )<tt> [static]</tt> </h3> Returns the database connection called <em>connectionName</em>. The database connection must have been previously added with @@ -301,7 +301,7 @@ in threaded applications. Please see the <a href="threads.html#threads-sql">Thre threading and SQL databases. <p>Examples: <a href="sql.html#x2156">sql/overview/basicbrowsing/main.cpp</a> and <a href="sql.html#x2155">sql/overview/create_connections/main.cpp</a>. -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="databaseName"></a>TQSqlDatabase::databaseName () const +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="databaseName"></a>TQSqlDatabase::databaseName () const </h3><p>Returns the name of the database. See the <a href="tqsqldatabase.html#databaseName-prop">"databaseName"</a> property for details. <h3 class=fn><a href="tqsqldriver.html">TQSqlDriver</a> * <a name="driver"></a>TQSqlDatabase::driver () const @@ -309,17 +309,17 @@ See the <a href="tqsqldatabase.html#databaseName-prop">"databaseName"</a> proper Returns the database driver used to access the database connection. -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="driverName"></a>TQSqlDatabase::driverName () const +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="driverName"></a>TQSqlDatabase::driverName () const </h3> Returns the name of the driver used by the database connection. -<h3 class=fn><a href="ntqstringlist.html">TQStringList</a> <a name="drivers"></a>TQSqlDatabase::drivers ()<tt> [static]</tt> +<h3 class=fn><a href="tqstringlist.html">TQStringList</a> <a name="drivers"></a>TQSqlDatabase::drivers ()<tt> [static]</tt> </h3> Returns a list of all the available database drivers. <p> Note that if you want to iterate over the list, you should iterate over a copy, e.g. <pre> - <a href="ntqstringlist.html">TQStringList</a> list = TQSqlDatabase::<a href="#drivers">drivers</a>(); + <a href="tqstringlist.html">TQStringList</a> list = TQSqlDatabase::<a href="#drivers">drivers</a>(); TQStringList::Iterator it = list.<a href="tqvaluelist.html#begin">begin</a>(); while( it != list.<a href="tqvaluelist.html#end">end</a>() ) { myProcessing( *it ); @@ -328,18 +328,18 @@ over a copy, e.g. </pre> -<h3 class=fn><a href="tqsqlquery.html">TQSqlQuery</a> <a name="exec"></a>TQSqlDatabase::exec ( const <a href="ntqstring.html">TQString</a> & query = TQString::null ) const +<h3 class=fn><a href="tqsqlquery.html">TQSqlQuery</a> <a name="exec"></a>TQSqlDatabase::exec ( const <a href="tqstring.html">TQString</a> & query = TQString::null ) const </h3> Executes a SQL statement (e.g. an <tt>INSERT</tt>, <tt>UPDATE</tt> or <tt>DELETE</tt> statement) on the database, and returns a <a href="tqsqlquery.html">TQSqlQuery</a> object. Use <a href="#lastError">lastError</a>() to retrieve error information. If <em>query</em> is -<a href="ntqstring.html#TQString-null">TQString::null</a>, an empty, invalid query is returned and lastError() +<a href="tqstring.html#TQString-null">TQString::null</a>, an empty, invalid query is returned and lastError() is not affected. <p> <p>See also <a href="tqsqlquery.html">TQSqlQuery</a> and <a href="#lastError">lastError</a>(). -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="hostName"></a>TQSqlDatabase::hostName () const +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="hostName"></a>TQSqlDatabase::hostName () const </h3><p>Returns the host name where the database resides. See the <a href="tqsqldatabase.html#hostName-prop">"hostName"</a> property for details. -<h3 class=fn>bool <a name="isDriverAvailable"></a>TQSqlDatabase::isDriverAvailable ( const <a href="ntqstring.html">TQString</a> & name )<tt> [static]</tt> +<h3 class=fn>bool <a name="isDriverAvailable"></a>TQSqlDatabase::isDriverAvailable ( const <a href="tqstring.html">TQString</a> & name )<tt> [static]</tt> </h3> Returns TRUE if a driver called <em>name</em> is available; otherwise returns FALSE. @@ -370,7 +370,7 @@ information can be retrieved using the <a href="#lastError">lastError</a>() func <p> <p>See also <a href="#lastError">lastError</a>(). <p>Examples: <a href="sql.html#x2142">sql/overview/connect1/main.cpp</a>, <a href="sql.html#x2149">sql/overview/connection.cpp</a>, and <a href="sqltable-example.html#x2456">sql/sqltable/main.cpp</a>. -<h3 class=fn>bool <a name="open-2"></a>TQSqlDatabase::open ( const <a href="ntqstring.html">TQString</a> & user, const <a href="ntqstring.html">TQString</a> & password ) +<h3 class=fn>bool <a name="open-2"></a>TQSqlDatabase::open ( const <a href="tqstring.html">TQString</a> & user, const <a href="tqstring.html">TQString</a> & password ) </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> Opens the database connection using the given <em>user</em> name and <em>password</em>. Returns TRUE on success; otherwise returns FALSE. Error @@ -380,18 +380,18 @@ the password is passed directly to the driver for opening a connection and is then discarded. <p> <p>See also <a href="#lastError">lastError</a>(). -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="password"></a>TQSqlDatabase::password () const +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="password"></a>TQSqlDatabase::password () const </h3><p>Returns the password used to connect to the database. See the <a href="tqsqldatabase.html#password-prop">"password"</a> property for details. <h3 class=fn>int <a name="port"></a>TQSqlDatabase::port () const </h3><p>Returns the port used to connect to the database. See the <a href="tqsqldatabase.html#port-prop">"port"</a> property for details. -<h3 class=fn><a href="tqsqlindex.html">TQSqlIndex</a> <a name="primaryIndex"></a>TQSqlDatabase::primaryIndex ( const <a href="ntqstring.html">TQString</a> & tablename ) const +<h3 class=fn><a href="tqsqlindex.html">TQSqlIndex</a> <a name="primaryIndex"></a>TQSqlDatabase::primaryIndex ( const <a href="tqstring.html">TQString</a> & tablename ) const </h3> Returns the primary index for table <em>tablename</em>. If no primary index exists an empty <a href="tqsqlindex.html">TQSqlIndex</a> will be returned. -<h3 class=fn><a href="tqsqlrecord.html">TQSqlRecord</a> <a name="record"></a>TQSqlDatabase::record ( const <a href="ntqstring.html">TQString</a> & tablename ) const +<h3 class=fn><a href="tqsqlrecord.html">TQSqlRecord</a> <a name="record"></a>TQSqlDatabase::record ( const <a href="tqstring.html">TQString</a> & tablename ) const </h3> Returns a <a href="tqsqlrecord.html">TQSqlRecord</a> populated with the names of all the fields in the table (or view) called <em>tablename</em>. The order in which the @@ -407,7 +407,7 @@ used in the SQL <em>query</em>. If the query is a "SELECT *" the order in which fields appear in the record is undefined. <p> <p>See also <a href="#recordInfo">recordInfo</a>(). -<h3 class=fn><a href="tqsqlrecordinfo.html">TQSqlRecordInfo</a> <a name="recordInfo"></a>TQSqlDatabase::recordInfo ( const <a href="ntqstring.html">TQString</a> & tablename ) const +<h3 class=fn><a href="tqsqlrecordinfo.html">TQSqlRecordInfo</a> <a name="recordInfo"></a>TQSqlDatabase::recordInfo ( const <a href="tqstring.html">TQString</a> & tablename ) const </h3> Returns a <a href="tqsqlrecordinfo.html">TQSqlRecordInfo</a> populated with meta data about the table or view <em>tablename</em>. If no such table (or view) exists, an empty @@ -423,7 +423,7 @@ information than the <a href="#recordInfo">recordInfo</a>() function which takes a table as parameter. <p> <p>See also <a href="tqsqlrecordinfo.html">TQSqlRecordInfo</a>, <a href="tqsqlfieldinfo.html">TQSqlFieldInfo</a>, and <a href="#record">record</a>(). -<h3 class=fn>void <a name="registerSqlDriver"></a>TQSqlDatabase::registerSqlDriver ( const <a href="ntqstring.html">TQString</a> & name, const TQSqlDriverCreatorBase * creator )<tt> [static]</tt> +<h3 class=fn>void <a name="registerSqlDriver"></a>TQSqlDatabase::registerSqlDriver ( const <a href="tqstring.html">TQString</a> & name, const TQSqlDriverCreatorBase * creator )<tt> [static]</tt> </h3> This function registers a new SQL driver called <em>name</em>, within the SQL framework. This is useful if you have a custom SQL driver @@ -438,7 +438,7 @@ and don't want to compile it as a plugin. <p> <b>Warning:</b> The framework takes ownership of the <em>creator</em> pointer, so it should not be deleted. -<h3 class=fn>void <a name="removeDatabase"></a>TQSqlDatabase::removeDatabase ( const <a href="ntqstring.html">TQString</a> & connectionName )<tt> [static]</tt> +<h3 class=fn>void <a name="removeDatabase"></a>TQSqlDatabase::removeDatabase ( const <a href="tqstring.html">TQString</a> & connectionName )<tt> [static]</tt> </h3> Removes the database connection <em>connectionName</em> from the list of database connections. @@ -464,32 +464,32 @@ transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. <p> <p>See also <a href="tqsqldriver.html#hasFeature">TQSqlDriver::hasFeature</a>(), <a href="#commit">commit</a>(), and <a href="#transaction">transaction</a>(). -<h3 class=fn>void <a name="setConnectOptions"></a>TQSqlDatabase::setConnectOptions ( const <a href="ntqstring.html">TQString</a> & options = TQString::null ) +<h3 class=fn>void <a name="setConnectOptions"></a>TQSqlDatabase::setConnectOptions ( const <a href="tqstring.html">TQString</a> & options = TQString::null ) </h3><p>Sets the database connect options to <em>options</em>. See the <a href="tqsqldatabase.html#connectOptions-prop">"connectOptions"</a> property for details. -<h3 class=fn>void <a name="setDatabaseName"></a>TQSqlDatabase::setDatabaseName ( const <a href="ntqstring.html">TQString</a> & name )<tt> [virtual]</tt> +<h3 class=fn>void <a name="setDatabaseName"></a>TQSqlDatabase::setDatabaseName ( const <a href="tqstring.html">TQString</a> & name )<tt> [virtual]</tt> </h3><p>Sets the name of the database to <em>name</em>. See the <a href="tqsqldatabase.html#databaseName-prop">"databaseName"</a> property for details. -<h3 class=fn>void <a name="setHostName"></a>TQSqlDatabase::setHostName ( const <a href="ntqstring.html">TQString</a> & host )<tt> [virtual]</tt> +<h3 class=fn>void <a name="setHostName"></a>TQSqlDatabase::setHostName ( const <a href="tqstring.html">TQString</a> & host )<tt> [virtual]</tt> </h3><p>Sets the host name where the database resides to <em>host</em>. See the <a href="tqsqldatabase.html#hostName-prop">"hostName"</a> property for details. -<h3 class=fn>void <a name="setPassword"></a>TQSqlDatabase::setPassword ( const <a href="ntqstring.html">TQString</a> & password )<tt> [virtual]</tt> +<h3 class=fn>void <a name="setPassword"></a>TQSqlDatabase::setPassword ( const <a href="tqstring.html">TQString</a> & password )<tt> [virtual]</tt> </h3><p>Sets the password used to connect to the database to <em>password</em>. See the <a href="tqsqldatabase.html#password-prop">"password"</a> property for details. <h3 class=fn>void <a name="setPort"></a>TQSqlDatabase::setPort ( int p )<tt> [virtual]</tt> </h3><p>Sets the port used to connect to the database to <em>p</em>. See the <a href="tqsqldatabase.html#port-prop">"port"</a> property for details. -<h3 class=fn>void <a name="setUserName"></a>TQSqlDatabase::setUserName ( const <a href="ntqstring.html">TQString</a> & name )<tt> [virtual]</tt> +<h3 class=fn>void <a name="setUserName"></a>TQSqlDatabase::setUserName ( const <a href="tqstring.html">TQString</a> & name )<tt> [virtual]</tt> </h3><p>Sets the user name connected to the database to <em>name</em>. See the <a href="tqsqldatabase.html#userName-prop">"userName"</a> property for details. -<h3 class=fn><a href="ntqstringlist.html">TQStringList</a> <a name="tables"></a>TQSqlDatabase::tables ( <a href="tqsql.html#TableType-enum">TQSql::TableType</a> type ) const +<h3 class=fn><a href="tqstringlist.html">TQStringList</a> <a name="tables"></a>TQSqlDatabase::tables ( <a href="tqsql.html#TableType-enum">TQSql::TableType</a> type ) const </h3> Returns a list of the database's tables, system tables and views, as specified by the parameter <em>type</em>. <p> Note that if you want to iterate over the list, you should iterate over a copy, e.g. <pre> - <a href="ntqstringlist.html">TQStringList</a> list = myDatabase.tables( TQSql::Tables | TQSql::Views ); + <a href="tqstringlist.html">TQStringList</a> list = myDatabase.tables( TQSql::Tables | TQSql::Views ); TQStringList::Iterator it = list.<a href="tqvaluelist.html#begin">begin</a>(); while( it != list.<a href="tqvaluelist.html#end">end</a>() ) { myProcessing( *it ); @@ -499,7 +499,7 @@ over a copy, e.g. <p>Example: <a href="sqltable-example.html#x2461">sql/sqltable/main.cpp</a>. -<h3 class=fn><a href="ntqstringlist.html">TQStringList</a> <a name="tables-2"></a>TQSqlDatabase::tables () const +<h3 class=fn><a href="tqstringlist.html">TQStringList</a> <a name="tables-2"></a>TQSqlDatabase::tables () const </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. <p> Returns a list of the database's tables that are visible to the @@ -508,7 +508,7 @@ function that takes a table <tt>type</tt> parameter. <p> Note that if you want to iterate over the list, you should iterate over a copy, e.g. <pre> - <a href="ntqstringlist.html">TQStringList</a> list = myDatabase.tables(); + <a href="tqstringlist.html">TQStringList</a> list = myDatabase.tables(); TQStringList::Iterator it = list.<a href="tqvaluelist.html#begin">begin</a>(); while( it != list.<a href="tqvaluelist.html#end">end</a>() ) { myProcessing( *it ); @@ -524,11 +524,11 @@ transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE. <p> <p>See also <a href="tqsqldriver.html#hasFeature">TQSqlDriver::hasFeature</a>(), <a href="#commit">commit</a>(), and <a href="#rollback">rollback</a>(). -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="userName"></a>TQSqlDatabase::userName () const +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="userName"></a>TQSqlDatabase::userName () const </h3><p>Returns the user name connected to the database. See the <a href="tqsqldatabase.html#userName-prop">"userName"</a> property for details. <hr><h2>Property Documentation</h2> -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="connectOptions-prop"></a>connectOptions</h3> +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="connectOptions-prop"></a>connectOptions</h3> <p>This property holds the database connect options. <p>The format of the options string is a semi-colon separated list of option names or option = value pairs. The options depend on the @@ -608,7 +608,7 @@ prior to opening the database connection. Setting new options without re-opening the connection does nothing. <p> <p>See also <p>Set this property's value with <a href="#setConnectOptions">setConnectOptions</a>() and get this property's value with <a href="#connectOptions">connectOptions</a>(). -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="databaseName-prop"></a>databaseName</h3> +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="databaseName-prop"></a>databaseName</h3> <p>This property holds the name of the database. <p>Note that the database name is the TNS Service Name for the <a href="sql-driver.html#TQOCI8">TQOCI8</a> (Oracle) driver. @@ -631,12 +631,12 @@ entry in the ODBC manager: <p> There is no default value. <p>Set this property's value with <a href="#setDatabaseName">setDatabaseName</a>() and get this property's value with <a href="#databaseName">databaseName</a>(). -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="hostName-prop"></a>hostName</h3> +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="hostName-prop"></a>hostName</h3> <p>This property holds the host name where the database resides. <p>There is no default value. <p>Set this property's value with <a href="#setHostName">setHostName</a>() and get this property's value with <a href="#hostName">hostName</a>(). -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="password-prop"></a>password</h3> +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="password-prop"></a>password</h3> <p>This property holds the password used to connect to the database. <p>There is no default value. <p> <b>Warning:</b> This function stores the password in plain text within @@ -650,7 +650,7 @@ avoid this behaviour. <p>There is no default value. <p>Set this property's value with <a href="#setPort">setPort</a>() and get this property's value with <a href="#port">port</a>(). -<h3 class=fn><a href="ntqstring.html">TQString</a> <a name="userName-prop"></a>userName</h3> +<h3 class=fn><a href="tqstring.html">TQString</a> <a name="userName-prop"></a>userName</h3> <p>This property holds the user name connected to the database. <p>There is no default value. |