SAP Sybase IQ PHP API Reference

The PHP API supports the following functions:

• sasql_affected_rows
  Returns the number of rows affected by the last SQL statement. This function is typically used for INSERT, UPDATE, or DELETE statements. For SELECT statements, use the sasql_num_rows function.
• sasql_commit
  Ends a transaction on the SQL Anywhere database and makes any changes made during the transaction permanent. Useful only when the auto_commit option is Off
• sasql_close
  Closes a previously opened database connection.
• sasql_connect
  Establishes a connection to an SAP Sybase IQ database.
• sasql_data_seek
  Positions the cursor on row row_num on the $result that was opened using sasql_query.
• sasql_disconnect
  Closes a connection that has been opened with sasql_connect or sasql_pconnect.
• sasql_error
  Returns the error text of the most recently executed SAP Sybase IQ PHP function. Error messages are stored per connection. If no $conn is specified, then sasql_error returns the last error message where no connection was available. For example, if you call sasql_connect and the connection fails, then call sasql_error with no parameter for $conn to get the error message. To obtain the corresponding error code value, use the sasql_errorcode function.
• sasql_errorcode
  Returns the error code of the most-recently executed SAP Sybase IQ PHP function. Error codes are stored per connection. If no $conn is specified, then sasql_errorcode returns the last error code where no connection was available. For example, if you are calling sasql_connect and the connection fails, then call sasql_errorcode with no parameter for the $conn to get the error code. To get the corresponding error message use the sasql_error function
• sasql_escape_string
  Escapes all special characters in the supplied string. The special characters that are escaped are \r, \n, ', ", ;, \, and the NULL character. This function is an alias of sasql_real_escape_string.
• sasql_fetch_array
  Fetches one row from the result set. This row is returned as an array that can be indexed by the column names or by the column indexes.
• sasql_fetch_assoc
  Fetches one row from the result set as an associative array.
• sasql_fetch_field
  Returns an object that contains information about a specific column.
• sasql_fetch_object
  Fetches one row from the result set as an object.
• sasql_fetch_row
  Fetches one row from the result set. This row is returned as an array that can be indexed by the column indexes only.
• sasql_field_count
  Returns the number of columns (fields) the last result contains.
• sasql_field_seek
  Sets the field cursor to the given offset. The next call to sasql_fetch_field will retrieve the field definition of the column associated with that offset.
• sasql_free_result
  Frees database resources associated with a result resource returned from sasql_query.
• sasql_get_client_info
  Returns the version information of the client.
• sasql_insert_id
  Returns the last value inserted into an IDENTITY column or a DEFAULT AUTOINCREMENT column, or zero if the most recent insert was into a table that did not contain an IDENTITY or DEFAULT AUTOINCREMENT column. The sasql_insert_id function is provided for compatibility with MySQL databases.
• sasql_message
  Writes a message to the server messages window.
• sasql_multi_query
  Prepares and executes one or more SQL queries specified by $sql_str using the supplied connection resource. Each query is separated from the other using semicolons. The first query result can be retrieved or stored using sasql_use_result or sasql_store_result. sasql_field_count can be used to check if the query returns a result set or not. All subsequent query results can be processed using sasql_next_result and sasql_use_result/sasql_store_result.
• sasql_next_result
  Prepares the next result set from the last query that executed on $conn.
• sasql_num_fields
  Returns the number of fields that a row in the $result contains.
• sasql_num_rows
  Returns the number of rows that the $result contains.
• sasql_pconnect
  Establishes a persistent connection to an SAP Sybase IQ database. Because of the way Apache creates child processes, you may observe a performance gain when using sasql_pconnect instead of sasql_connect. Persistent connections may provide improved performance in a similar fashion to connection pooling. If your database server has a limited number of connections (for example, the personal database server is limited to 10 concurrent connections), caution should be exercised when using persistent connections. Persistent connections could be attached to each of the child processes, and if you have more child processes in Apache than there are available connections, you will receive connection errors.
• sasql_prepare
  Prepares the supplied SQL string.
• sasql_query
  Prepares and executes the SQL query $sql_str on the connection identified by $conn that has already been opened using sasql_connect or sasql_pconnect. The sasql_query function is equivalent to calling two functions, sasql_real_query and one of sasql_store_result or sasql_use_result.
• sasql_real_escape_string
  Escapes all special characters in the supplied string. The special characters that are escaped are \r, \n, ', ", ;, \, and the NULL character.
• sasql_real_query
  Executes a query against the database using the supplied connection resource. The query result can be retrieved or stored using sasql_store_result or sasql_use_result. The sasql_field_count function can be used to check if the query returns a result set or not. The sasql_query function is equivalent to calling this function and one of sasql_store_result or sasql_use_result.
• sasql_result_all
  Fetches all results of the $result and generates an HTML output table with an optional formatting string.
• sasql_rollback
  Ends a transaction on the database and discards any changes made during the transaction. This function is only useful when the auto_commit option is Off.
• sasql_set_option
  Sets the value of the specified option on the specified connection.
• sasql_stmt_affected_rows
  Returns the number of rows affected by executing the statement.
• sasql_stmt_bind_param
  Binds PHP variables to statement parameters.
• sasql_stmt_bind_param_ex
  Binds a PHP variable to a statement parameter.
• sasql_stmt_bind_result
  Binds one or more PHP variables to result columns of a statement that was executed, and returns a result set.
• sasql_stmt_close
  Closes the supplied statement resource and frees any resources associated with it. This function will also free any result objects that were returned by the sasql_stmt_result_metadata.
• sasql_stmt_data_seek
  This function seeks to the specified offset in the result set.
• sasql_stmt_errno
  Returns the error code for the most recently executed statement function using the specified statement resource.
• sasql_stmt_error
  Returns the error text for the most recently executed statement function using the specified statement resource.
• sasql_stmt_execute
  Executes the prepared statement. The sasql_stmt_result_metadata can be used to check whether the statement returns a result set.
• sasql_stmt_fetch
  This function fetches one row out of the result for the statement and places the columns in the variables that were bound using sasql_stmt_bind_result.
• sasql_stmt_field_count
  This function returns the number of columns in the result set of the statement.
• sasql_stmt_free_result
  This function frees cached result set of the statement.
• sasql_stmt_insert_id
  Returns the last value inserted into an IDENTITY column or a DEFAULT AUTOINCREMENT column, or zero if the most recent insert was into a table that did not contain an IDENTITY or DEFAULT AUTOINCREMENT column.
• sasql_stmt_next_result
  This function advances to the next result from the statement. If there is another result set, the currently cashed results are discarded and the associated result set object deleted (as returned by sasql_stmt_result_metadata).
• sasql_stmt_num_rows
  Returns the number of rows in the result set. The actual number of rows in the result set can only be determined after the sasql_stmt_store_result function is called to buffer the entire result set. If the sasql_stmt_store_result function has not been called, 0 is returned.
• sasql_stmt_param_count
  Returns the number of parameters in the supplied prepared statement resource.
• sasql_stmt_reset
  This function resets the $stmt object to the state just after the describe. Any variables that were bound are unbound and any data sent using sasql_stmt_send_long_data are dropped.
• sasql_stmt_result_metadata
  Returns a result set object for the supplied statement.
• sasql_stmt_send_long_data
  Allows the user to send parameter data in chunks. The user must first call sasql_stmt_bind_param or sasql_stmt_bind_param_ex before attempting to send any data. The bind parameter must be of type string or blob. Repeatedly calling this function appends on to what was previously sent.
• sasql_stmt_store_result
  This function allows the client to cache the whole result set of the statement. You can use the function sasql_stmt_free_result to free the cached result.
• sasql_store_result
  Transfers the result set from the last query on the database connection $conn to be used with the sasql_data_seek function.
• sasql_sqlstate
  Returns the most recent SQLSTATE string. SQLSTATE indicates whether the most recently executed SQL statement resulted in a success, error, or warning condition. SQLSTATE codes consists of five characters with "00000" representing no error. The values are defined by the ISO/ANSI SQL standard.
• sasql_use_result
  Initiates a result set retrieval for the last query that executed on the connection.