CallResult

SQL::CallResult

R

Returns the results of the last call.

ConnectionString

C

RW

The current connection string in syntax format. Should be set by ::SetConnectString().

ConnectionTimeout

C

RW

Timeout values are "Default", "Infinite", or a string containing an integer specifying the timeout in seconds. Must be set prior to opening the connection.

CurrentAPI

C

R

The name of the current application programming interface being used. For example: Access, Oracle, ODBC, MySQL.

CurrentSyntax

C

R

The dialect of SQL (and typically the vendor or product) being used to interact with the database.

IsOpen

L

R

Returns true if the connection is currently open and false if it has not been opened yet or has been closed.

LoginTimeout

C

RW

Timeout values are "Default", "Infinite", or a string containing an integer specifying the timeout in seconds. Must be set prior to opening the connection.

PortableSQLEnabled

L

RW

Default = FALSE (.F.). When this property is set to true, SQL statements passed to the ApplyData(), Execute(), ToOpenTable(), ToGridComponentDataObject(), ToOpenTable(), ToPropertyArray(), ToString(), ToXML(), and ValidateQuery() methods are checked to see if they are supported Portable SQL Statements and, if so, then translated to native syntax before being processed. Statements that are not supported are passed directly through to the underlying database driver as if PortableSQLEnabled were false.

QueryTimeout

C

RW

Timeout values are "Default", "Infinite", or a string containing an integer specifying the timeout in seconds. Must be set prior to executing a query.

ResultSet

SQL::ResultSet

R

Returns the currently active result set, or an error if there isn't one.

SchemaCacheEnabled

L

RW

Default = TRUE (.T.). When this property is set to TRUE (.T.), schema objects retrieved (such as SQL::TableInfo) will be cached for the connection (disconnecting and some update functions clear the cache), when false, all objects are not cached and subsequent requests for a schema object will go directly to the database.

::AddEventScript()

Adds an additional event script (see SQL Events) to the connection.

::ClearSchemaCache()

Forces all objects held in the connections cache to be freed.

::Close()

Closes a SQL connection.

::GetConnectDialogScript()

Retrieves the API specific XDialog syntax for the dialog to prompt for a connection string.

::GetExampleSyntaxScript()

Returns a syntax script implemented in some detail to show how to write a syntax handler.

::GetPreferredSyntax()

Returns a the most appropriate syntax for the server specified or an empty string if not known.

::GetSchema()

Returns a collection of the tables requested for the current database and optionally for those owned by a specific user.

::GetTemplateSyntaxScript()

Returns a syntax script with all function prototypes for building a syntax handler.

::ListAPIs()

Creates a CR-LF delimited list of installed SQL Application Programming Interfaces.

::ListDatabases()

Returns a list of databases from the current server.

::ListAutoIncrement

Implementations()

Create a CR-LF delimited list of valid auto-increment implementations current syntax.

::ListPortableSQLFunctions()

Creates a CR-LF delimited list of portable functions.

::ListProcedureLanguages()

Create a CR-LF delimited list of valid procedure languages for the current syntax.

::ListProperties()

Creates a list of property names and values in the format Name <TAB> Value <CR-LF>.

::ListServers()

Returns a list of servers for the current connection Application Programming Interface (API).

::ListSyntaxes()

Create a CR-LF delimited list of installed SQL syntaxes.

::ListTables()

Returns a list of tables for the current database.

::ListTablesWithTypes()

Returns a list of tables for the current database suffixed with (<type>).

::MaskPassword()

Reformats a password so it will not be readable.

::Open()

Connects to a database and sets a the values of a SQL::Connection object.

::RemoveEventScript()

Removes an event script (see SQL Events ) from the connection.

::SetConnectionString()

Sets the connection string with required parameters. The actual values will depend on how you are connecting to your database.

::GenerateAddUserGroupStatement()

::GenerateAddUserStatement()

::GenerateAddUserToGroupStatement()

::GenerateCreateDatabaseStatement()

::GenerateCreateIndexStatement()

::GenerateCreateTableStatement()

Generates a SQL Create Table statement.

::GenerateDeleteStatement()

Generates a SQL Delete statement.

::GenerateDropDatabaseStatement()

::GenerateDropIndexStatement()

::GenerateDropTableStatement()

::GenerateDropUserFromGroupStatement()

::GenerateDropUserGroupStatement()

::GenerateDropUserStatement()

::GenerateGrantAccessStatement()

::GenerateInsertStatement()

Generates a SQL Insert statement for a table.

::GenerateLastInsertedIdentityStatement()

Generates the SQL to retrieve the last identity value generated for an insert on the currently open connection.

::GenerateRowQualifiers()

Generates a list of key columns for a table based on the primary key.

::GenerateSelectStatement()

Generate a SQL Select statement for a table.

::GenerateUpdateStatement()

Generates a SQL Update statement for a table.

::GenerateWhereClause()

Generates a SQL Where Clause based on criteria.

::GrantRevokeAccessStatement()

::LastInsertedIdentity()

Retrieves the last identity inserted for the current connection/table.

::SetSyntaxHandlerScript()

Assigns a handler script for the connection to override the default behavior of some or all of the event functions.

::Execute()

Executes a query on the connection using SQL.

::FetchToXML()

Fetches data to an XML formatted string using a SQL query.

::FreeResult()

Releases the result set from the last SQL select statement.

::LastInsertedIdentity()

Retrieves the last identity value generated for an insert on the currently open connection.

::ResultSetFromDBF()

Creates a SQL::ResultSet object for a table.

::ToOpenTable()

Fetches data to an Alpha Five .DBF table using a SQL query.

::ToGridComponentDataObject()

Fetches data to a Grid Component Data Object using a SQL Query.

::ToJSON()

Converts the data in one or more rows to an implementation of JavaScript Object Notation format specific to the Alpha Five AJAX implementation.

::ToOpenTable()

Fetches rows from a SQL database to a local .DBF file.

::ToPropertyArray()

Fetches data to a property array using a SQL query.

::ToString()

Fetches data to a string using a SQL query.

::ValidateQuery()

Validates a SQL query on the connection.

::AffectedRows()

Returns the number of affected rows.

::ApplyData()

Applies the query to existing rows in a table in the currently connected database using the result set provided.

::DeleteData()

Deletes rows from a table in the currently connected database using a result set.

::InsertData()

Applies new rows to a table in the currently connected database using a result set.

::UpdateData()

Applies changes to existing rows.

::BeginTransaction()

Begins a batch of SQL updates, inserts and/or deletes that need to succeed or fail as a group.

::CommitTransaction()

Applies a set of changes started with ::BeginTransaction().

::RollBackTransaction()

Undoes a set of changes started with ::BeginTransaction(), but not yet applied with ::CommitTransaction().

::CreateDatabase()

Creates a new database.

::CreateIndex()

Creates an index on the specified table in the currently connected database using SQL::TableInfo and SQL::IndexColumnInfo objects.

::CreateTable()

Creates a table in the currently connected database using a SQL::TableInfo object.

::DropDatabase()

Removes a database.

::DropIndex()

Drops the index named from table specified in the currently connected database.

::DropTable()

Drops the table named from the currently connected database.

::GetTableInfo()

Returns the definition of a table.

::PrimaryKeyExpression()

Returns the primary key expression for a table.

::AddUser()

Creates a new user in the currently connected database or server.

::AddUserGroup()

Makes the user a member of the group in the currently connected database or server.

::AddUserToGroup()

Makes the user a member of the group in the currently connected database or server.

::DropDatabase()

Removes a database.

::DropUser()

Removes the user named from the currently connected database or server.

::DropUserFromGroup()

Removes the user from the group in the currently connected database or server.

::DropUserGroup()

Removes the user group named from the currently connected database or server.

::GenerateAddUserStatement()

::GrantAccess()

Grants specified access to a resource to a user or group.

::RevokeAccess()

Revokes the specified access to the resource from a user or group.

::GenerateNativeColumnName()

Generates a formatted column name suitable for a SQL query using the current syntax.

::GenerateNativeTableName()

Generates a formatted table name suitable for a SQL query using the current syntax.

::GenerateNativeTypeString()

Generates a SQL type string for a type using the current syntax.