diff --git a/functions/fbsql.xml b/functions/fbsql.xml index 97e9fa98e5..8c6e250dc0 100644 --- a/functions/fbsql.xml +++ b/functions/fbsql.xml @@ -1,5 +1,5 @@ - + FrontBase functions FrontBase @@ -48,7 +48,6 @@ - &warn.experimental.func; fbsql_affected_rows returns the number of rows affected by the last INSERT, UPDATE or DELETE query @@ -106,12 +105,20 @@ - &warn.experimental.func; fbsql_autocommit returns the current autocommit status. if the optional OnOff parameter is given the auto commit status will be changed. + With OnOff set to &true each statement will be commited + automatically, if no errors was found. + With OnOff set to &false the user must commit or rollback + the transaction unsing either fbsql_commit or + fbsql_rollback. + See also: + fbsql_commit and + fbsql_rollback + @@ -141,7 +148,6 @@ - &warn.experimental.func; fbsql_change_user changes the logged in user of the current active connection, or the connection given by the @@ -170,7 +176,6 @@ - &warn.experimental.func; Returns: &true; on success, &false; on error. @@ -201,6 +206,39 @@ + + + + fbsql_commit + Commits a transaction to the database + + + Description + + + bool fbsql_commit + resource + + link_identifier + + + + + + Returns: &true; on success, &false; on failure. + + + fbsql_commit ends the current transaction + by writing all insertsm updates and deletes to the disk and unlucking + all row and table locks held by the transaction. + This command is only needed if autocommit is set to false. + + See also: + fbsql_autocommit and + fbsql_rollback + + + @@ -230,7 +268,6 @@ - &warn.experimental.func; Returns a positive FrontBase link identifier on success, or an error message on failure. @@ -292,7 +329,6 @@ - &warn.experimental.func; fbsql_create_db attempts to create a new database on the server associated with the specified link @@ -336,7 +372,6 @@ - &warn.experimental.func; Returns: The database password for the database represented by the link identifier. @@ -372,7 +407,6 @@ int row_number - &warn.experimental.func; Returns: &true; on success, &false; on failure. @@ -440,7 +474,6 @@ - &warn.experimental.func; Returns: A positive FrontBase result identifier to the query result, or &false; on error. @@ -459,6 +492,85 @@ + + + fbsql_db_status + Get the status for a given database. + + + Description + + + int fbsql_db_status + string database_name + resource + + link_identifier + + + + + + Returns: An integer value with the current status. + + + fbsql_db_status requests the current + status of the database specified by database_name. + if the link_identifier is omitted the default + link_identifier will be used. + + + The return value can be one of the following constants: + + + + &false - The exec handler for the host was invalid. This + error will ocour when the link_identifier connects directly to + a database by using a port number. FBExec can be available on the + server but no connection has been made for it. + + + + + FBSQL_UNKNOWN - The Status is unknown. + + + + + FBSQL_STOPPED - The database is not running. Use + fbsql_start_db to start the database. + + + + + FBSQL_STARTING - The database is starting. + + + + + FBSQL_RUNNING - The database is running and can be used to + perform SQL operations. + + + + + FBSQL_STOPPING - The database is stopping. + + + + + FBSQL_NOEXEC - FBExec is not running on the server and it is not + possible to get the status of the database. + + + + See also: + fbsql_start_db and + fbsql_stop_db + + + + fbsql_drop_db @@ -477,7 +589,6 @@ - &warn.experimental.func; Returns: &true; on success, &false; on failure. @@ -507,7 +618,6 @@ - &warn.experimental.func; Returns the error number from the last fbsql function, or 0 (zero) if no error occurred. @@ -559,7 +669,6 @@ echo fbsql_errno().": ".fbsql_error()."<BR>"; - &warn.experimental.func; Returns the error text from the last fbsql function, or '' (the empty string) if no error occurred. @@ -612,7 +721,6 @@ echo fbsql_errno().": ".fbsql_error()."<BR>"; - &warn.experimental.func; Returns an array that corresponds to the fetched row, or &false; if there are no more rows. @@ -683,7 +791,6 @@ fbsql_free_result ($result); resource result - &warn.experimental.func; Returns an associative array that corresponds to the fetched row, or &false; if there are no more rows. @@ -748,7 +855,6 @@ fbsql_free_result ($result); - &warn.experimental.func; Returns an object containing field information. @@ -840,7 +946,6 @@ fbsql_free_result ($result); - &warn.experimental.func; Returns: An array that corresponds to the lengths of each field in the last row fetched by fbsql_fetch_row, @@ -878,7 +983,6 @@ fbsql_free_result ($result); - &warn.experimental.func; Returns an object with properties that correspond to the fetched row, or &false; if there are no more rows. @@ -935,7 +1039,6 @@ fbsql_free_result ($result); resource result - &warn.experimental.func; Returns: An array that corresponds to the fetched row, or &false; if there are no more rows. @@ -977,7 +1080,6 @@ fbsql_free_result ($result); int field_offset - &warn.experimental.func; fbsql_field_flags returns the field flags of the specified field. The flags are reported as a single word @@ -1003,7 +1105,6 @@ fbsql_free_result ($result); int field_index - &warn.experimental.func; fbsql_field_name returns the name of the specified field index. result must be a @@ -1063,7 +1164,6 @@ password int field_offset - &warn.experimental.func; fbsql_field_len returns the length of the specified field. @@ -1087,7 +1187,6 @@ password int field_offset - &warn.experimental.func; Seeks to the specified field offset. If the next call to fbsql_fetch_field doesn't include a field @@ -1116,7 +1215,6 @@ password int field_offset - &warn.experimental.func; Returns the name of the table that the specifed field is in. @@ -1140,7 +1238,6 @@ password int field_offset - &warn.experimental.func; fbsql_field_type is similar to the fbsql_field_name function. The arguments are @@ -1192,7 +1289,6 @@ fbsql_close(); int result - &warn.experimental.func; fbsql_free_result will free all memory associated with the result identifier result. @@ -1225,7 +1321,6 @@ fbsql_close(); - &warn.experimental.func; fbsql_insert_id returns the ID generated for an column defined as DEFAULT UNIQUE by the previous INSERT query using the @@ -1269,7 +1364,6 @@ fbsql_close(); - &warn.experimental.func; fbsql_list_dbs will return a result pointer containing the databases available from the current fbsql @@ -1328,7 +1422,6 @@ database3 - &warn.experimental.func; fbsql_list_fields retrieves information about the given tablename. Arguments are the database name and @@ -1392,7 +1485,6 @@ field3 - &warn.experimental.func; fbsql_list_tables takes a database name and returns a result pointer much like the @@ -1418,7 +1510,6 @@ field3 int result_id - &warn.experimental.func; When sending more than one SQL statement to the server or executing a stored procedure with multiple results will cause the server to return multiple result sets. @@ -1461,7 +1552,6 @@ field3 resource result - &warn.experimental.func; fbsql_num_fields returns the number of fields in a result set. @@ -1488,7 +1578,6 @@ field3 resource result - &warn.experimental.func; fbsql_num_rows returns the number of rows in a result set. This command is only valid for SELECT statements. @@ -1544,7 +1633,6 @@ echo "$num_rows Rows\n"; - &warn.experimental.func; Returns: A positive FrontBase persistent link identifier on success, or &false; on error. @@ -1596,7 +1684,6 @@ echo "$num_rows Rows\n"; - &warn.experimental.func; fbsql_query sends a query to the currently active database on the server that's associated with the @@ -1699,7 +1786,6 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl") - &warn.experimental.func; fbsql_result returns the contents of one cell from a FrontBase result set. The field argument can be the @@ -1730,6 +1816,38 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl") + + + fbsql_rollback + Rollback a transaction to the database + + + Description + + + bool fbsql_rollback + resource + + link_identifier + + + + + + Returns: &true; on success, &false; on failure. + + + fbsql_rollback ends the current transaction by + rolling back all statements issued since last commit. + This command is only needed if autocommit is set to false. + + See also: + fbsql_autocommit and + fbsql_commit + + + + fbsql_select_db @@ -1748,7 +1866,6 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl") - &warn.experimental.func; Returns: &true; on success, &false; on error. @@ -1780,6 +1897,68 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl") + + + fbsql_start_db + Start a database on local or remote server + + + Description + + + bool fbsql_start_db + string database_name + resource + + link_identifier + + + + + + Returns: &true; on success, &false; on failure. + + + fbsql_start_db + + See also: + fbsql_db_status and + fbsql_stop_db + + + + + + + fbsql_stop_db + Stop a database on local or remote server + + + Description + + + bool fbsql_stop_db + string database_name + resource + + link_identifier + + + + + + Returns: &true; on success, &false; on failure. + + + fbsql_stop_db + + See also: + fbsql_db_status and + fbsql_start_db + + + + fbsql_tablename @@ -1794,7 +1973,6 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl") int i - &warn.experimental.func; fbsql_tablename takes a result pointer returned by the fbsql_list_tables function @@ -1837,7 +2015,6 @@ while ($i < fbsql_num_rows ($result)) { - &warn.experimental.func; Returns &true; if warnings is turned on otherwise &false;.