qsqldatabase.3qt

Linux下的基于X11的图形开发环境。

'\" t
.TH QSqlDatabase 3qt "9 December 2002" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2001 Trolltech AS.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QSqlDatabase \- Used to create SQL database connections and provide transaction handling
.SH SYNOPSIS
\fC#include <qsqldatabase.h>\fR
.PP
Inherits QObject.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fB~QSqlDatabase\fR ()"
.br
.ti -1c
.BI "bool \fBopen\fR ()"
.br
.ti -1c
.BI "bool \fBopen\fR ( const QString & user, const QString & password )"
.br
.ti -1c
.BI "void \fBclose\fR ()"
.br
.ti -1c
.BI "bool \fBisOpen\fR () const"
.br
.ti -1c
.BI "bool \fBisOpenError\fR () const"
.br
.ti -1c
.BI "QStringList \fBtables\fR () const"
.br
.ti -1c
.BI "QSqlIndex \fBprimaryIndex\fR ( const QString & tablename ) const"
.br
.ti -1c
.BI "QSqlRecord \fBrecord\fR ( const QString & tablename ) const"
.br
.ti -1c
.BI "QSqlRecord \fBrecord\fR ( const QSqlQuery & query ) const"
.br
.ti -1c
.BI "QSqlRecordInfo \fBrecordInfo\fR ( const QString & tablename ) const"
.br
.ti -1c
.BI "QSqlRecordInfo \fBrecordInfo\fR ( const QSqlQuery & query ) const"
.br
.ti -1c
.BI "QSqlQuery \fBexec\fR ( const QString & query = QString::null ) const"
.br
.ti -1c
.BI "QSqlError \fBlastError\fR () const"
.br
.ti -1c
.BI "bool \fBtransaction\fR ()"
.br
.ti -1c
.BI "bool \fBcommit\fR ()"
.br
.ti -1c
.BI "bool \fBrollback\fR ()"
.br
.ti -1c
.BI "virtual void \fBsetDatabaseName\fR ( const QString & name )"
.br
.ti -1c
.BI "virtual void \fBsetUserName\fR ( const QString & name )"
.br
.ti -1c
.BI "virtual void \fBsetPassword\fR ( const QString & password )"
.br
.ti -1c
.BI "virtual void \fBsetHostName\fR ( const QString & host )"
.br
.ti -1c
.BI "virtual void \fBsetPort\fR ( int p )"
.br
.ti -1c
.BI "QString \fBdatabaseName\fR () const"
.br
.ti -1c
.BI "QString \fBuserName\fR () const"
.br
.ti -1c
.BI "QString \fBpassword\fR () const"
.br
.ti -1c
.BI "QString \fBhostName\fR () const"
.br
.ti -1c
.BI "QString \fBdriverName\fR () const"
.br
.ti -1c
.BI "int \fBport\fR () const"
.br
.ti -1c
.BI "QSqlDriver * \fBdriver\fR () const"
.br
.in -1c
.SS "Static Public Members"
.in +1c
.ti -1c
.BI "QSqlDatabase * \fBaddDatabase\fR ( const QString & type, const QString & connectionName = defaultConnection )"
.br
.ti -1c
.BI "QSqlDatabase * \fBdatabase\fR ( const QString & connectionName = defaultConnection, bool open = TRUE )"
.br
.ti -1c
.BI "void \fBremoveDatabase\fR ( const QString & connectionName )"
.br
.ti -1c
.BI "bool \fBcontains\fR ( const QString & connectionName = defaultConnection )"
.br
.ti -1c
.BI "QStringList \fBdrivers\fR ()"
.br
.in -1c
.SS "Properties"
.in +1c
.ti -1c
.BI "QString \fBdatabaseName\fR - the name of the database"
.br
.ti -1c
.BI "QString \fBhostName\fR - the host name where the database resides"
.br
.ti -1c
.BI "QString \fBpassword\fR - the password used to connect to the database"
.br
.ti -1c
.BI "int \fBport\fR - the port used to connect to the database"
.br
.ti -1c
.BI "QString \fBuserName\fR - the user name connected to the database"
.br
.in -1c
.SS "Protected Members"
.in +1c
.ti -1c
.BI "\fBQSqlDatabase\fR ( const QString & driver, const QString & name, QObject * parent = 0, const char * objname = 0 )"
.br
.in -1c
.SH DESCRIPTION
The QSqlDatabase class is used to create SQL database connections and provide transaction handling.
.PP
This class is used to create connections to SQL databases. It also provides transaction handling functions for those database drivers that support transactions.
.PP
The QSqlDatabase class itself provides an abstract interface for accessing many types of database backend. Database-specific drivers are used internally to actually access and manipulate data, (see QSqlDriver). Result set objects provide the interface for executing and manipulating SQL queries (see QSqlQuery).
.PP
See also Database Classes.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QSqlDatabase::QSqlDatabase ( const QString & driver, const QString & name, QObject * parent = 0, const char * objname = 0 )\fC [protected]\fR"
Creates a QSqlDatabase connection called \fIname\fR that uses the driver referred to by \fIdriver\fR, with the parent \fIparent\fR and the object name \fIobjname\fR. If the \fIdriver\fR is not recognized, the database connection will have no functionality.
.PP
The currently available drivers are:
.TP
QODBC3 - ODBC (Open Database Connectivity) Driver
.TP
QOCI8 - Oracle Call Interface Driver
.TP
QPSQL7 - PostgreSQL v6.x and v7.x Driver
.TP
QTDS7 - Sybase Adaptive Server and Microsoft SQL Server Driver
.TP
QMYSQL3 - MySQL Driver
.PP
Note that additional 3<sup>rd</sup> party drivers can be loaded dynamically.
.SH "QSqlDatabase::~QSqlDatabase ()"
Destroys the object and frees any allocated resources.
.SH "QSqlDatabase * QSqlDatabase::addDatabase ( const QString & type, const QString & connectionName = defaultConnection )\fC [static]\fR"
Adds a database to the list of database connections using the driver \fItype\fR and the connection name \fIconnectionName\fR.
.PP
The database connection is referred to by \fIconnectionName\fR. The newly added database connection is returned. This pointer is owned by QSqlDatabase and will be deleted on program exit or when removeDatabase() is called. If \fIconnectionName\fR is not specified, the newly added database connection becomes the default database connection for the application, and subsequent calls to database() (without a database name parameter) will return a pointer to it.
.PP
See also database() and removeDatabase().
.PP
Examples:
.)l sql/overview/connect1/main.cpp, sql/overview/connection.cpp, and sql/sqltable/main.cpp.
.SH "void QSqlDatabase::close ()"
Closes the database connection, freeing any resources acquired.
.SH "bool QSqlDatabase::commit ()"
Commits a transaction to the database if the driver supports transactions. Returns TRUE if the operation succeeded; otherwise returns FALSE.
.PP
See also QSqlDriver::hasFeature() and rollback().
.SH "bool QSqlDatabase::contains ( const QString & connectionName = defaultConnection )\fC [static]\fR"