diff --git a/reference/msql/functions/msql-affected-rows.xml b/reference/msql/functions/msql-affected-rows.xml index 762a906072..9987061f4e 100644 --- a/reference/msql/functions/msql-affected-rows.xml +++ b/reference/msql/functions/msql-affected-rows.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description intmsql_affected_rows - intquery_identifier + resourcequery_identifier Returns number of affected ("touched") rows by a specific query diff --git a/reference/msql/functions/msql-close.xml b/reference/msql/functions/msql-close.xml index 7f66ab08cb..68888e7d63 100644 --- a/reference/msql/functions/msql-close.xml +++ b/reference/msql/functions/msql-close.xml @@ -1,5 +1,5 @@ - + @@ -10,17 +10,17 @@ Description intmsql_close - intlink_identifier + resourcelink_identifier - - Returns &true; on success, &false; on error. - msql_close closes the link to a mSQL database that's associated with the specified link identifier. If the link identifier isn't specified, the last opened link is assumed. + + &return.success; + Note that this isn't usually necessary, as non-persistent open links are automatically closed at the end of the script's @@ -31,7 +31,8 @@ generated by msql_pconnect. - See also: msql_connect and + See also: + msql_connect and msql_pconnect. diff --git a/reference/msql/functions/msql-connect.xml b/reference/msql/functions/msql-connect.xml index b3c21ce041..b04c4ccf02 100644 --- a/reference/msql/functions/msql-connect.xml +++ b/reference/msql/functions/msql-connect.xml @@ -1,5 +1,5 @@ - + @@ -10,18 +10,10 @@ Description intmsql_connect - string - hostname - - string - server - - string - username - - string - password - + stringhostname + stringserver + stringusername + stringpassword msql_connect establishes a connection to a diff --git a/reference/msql/functions/msql-create-db.xml b/reference/msql/functions/msql-create-db.xml index 191ec0cb35..5f0850d4e3 100644 --- a/reference/msql/functions/msql-create-db.xml +++ b/reference/msql/functions/msql-create-db.xml @@ -1,5 +1,5 @@ - + @@ -9,13 +9,16 @@ Description - intmsql_create_db + boolmsql_create_db stringdatabase_name - intlink_identifier + resourcelink_identifier msql_create_db attempts to create a new database on the server - associated with the specified link identifier. + associated with the specified link_identifier. + + + &return.success; See also diff --git a/reference/msql/functions/msql-createdb.xml b/reference/msql/functions/msql-createdb.xml index 961ba965d7..e4a8698d96 100644 --- a/reference/msql/functions/msql-createdb.xml +++ b/reference/msql/functions/msql-createdb.xml @@ -1,20 +1,15 @@ - + msql_createdb - Create mSQL database + Alias of msql_create_db Description - - intmsql_createdb - stringdatabase_name - intlink_identifier - - Identical to msql_create_db. + This function is an alias of msql_create_db. diff --git a/reference/msql/functions/msql-data-seek.xml b/reference/msql/functions/msql-data-seek.xml index 20a852f686..3e412724a9 100644 --- a/reference/msql/functions/msql-data-seek.xml +++ b/reference/msql/functions/msql-data-seek.xml @@ -1,5 +1,5 @@ - + @@ -9,8 +9,8 @@ Description - intmsql_data_seek - intquery_identifier + boolmsql_data_seek + resourcequery_identifier introw_number diff --git a/reference/msql/functions/msql-db-query.xml b/reference/msql/functions/msql-db-query.xml new file mode 100644 index 0000000000..78812dbee4 --- /dev/null +++ b/reference/msql/functions/msql-db-query.xml @@ -0,0 +1,52 @@ + + + + + msql + Send mSQL query + + + Description + + resoucemsql_db_query + stringdatabase + stringquery + resourcelink_identifier + + + Returns a positive mSQL query identifier to the query result, or + &false; on error. + + + msql_db_query selects a database and executes a query + on it. If the optional link_identifier + is not specified, the function will try to find an open link to the mSQL + server; if no such link is found it will try to create one as if + msql_connect was called with no arguments. + + + See also msql_connect. + + + + + \ No newline at end of file diff --git a/reference/msql/functions/msql-dbname.xml b/reference/msql/functions/msql-dbname.xml index 770c8c1fab..eb8bcab446 100644 --- a/reference/msql/functions/msql-dbname.xml +++ b/reference/msql/functions/msql-dbname.xml @@ -1,24 +1,15 @@ - + msql_dbname - Get current mSQL database name + Alias of msql_result Description - - stringmsql_dbname - intquery_identifier - inti - - msql_dbname returns the database name stored - in position i of the result pointer - returned from the msql_listdbs function. The - msql_numrows function can be used to - determine how many database names are available. + This function is an alias of msql_result. diff --git a/reference/msql/functions/msql-drop-db.xml b/reference/msql/functions/msql-drop-db.xml index a6701f3cca..0fdebb2da9 100644 --- a/reference/msql/functions/msql-drop-db.xml +++ b/reference/msql/functions/msql-drop-db.xml @@ -1,5 +1,5 @@ - + @@ -11,7 +11,7 @@ intmsql_drop_db stringdatabase_name - intlink_identifier + resourcelink_identifier &return.success; diff --git a/reference/msql/functions/msql-dropdb.xml b/reference/msql/functions/msql-dropdb.xml index 926e7947a5..63bd87ae4f 100644 --- a/reference/msql/functions/msql-dropdb.xml +++ b/reference/msql/functions/msql-dropdb.xml @@ -1,15 +1,15 @@ - + msql_dropdb - Drop (delete) mSQL database + Alias of msql_drop_db Description - See msql_drop_db. + This function is an alias of msql_drop_db. diff --git a/reference/msql/functions/msql-error.xml b/reference/msql/functions/msql-error.xml index 8af5d651e9..683d9766b1 100644 --- a/reference/msql/functions/msql-error.xml +++ b/reference/msql/functions/msql-error.xml @@ -1,5 +1,5 @@ - + @@ -10,11 +10,11 @@ Description stringmsql_error - intlink_identifier + resourcelink_identifier Errors coming back from the mSQL database backend no longer - issue warnings. Instead, use these functions to retrieve the + issue warnings. Instead, use this functions to retrieve the error string. diff --git a/reference/msql/functions/msql-fetch-array.xml b/reference/msql/functions/msql-fetch-array.xml index 98d5cae411..8de2b84a7d 100644 --- a/reference/msql/functions/msql-fetch-array.xml +++ b/reference/msql/functions/msql-fetch-array.xml @@ -1,5 +1,5 @@ - + @@ -26,7 +26,8 @@ The second optional argument result_type in msql_fetch_array is a constant and can - take the following values: MSQL_ASSOC, MSQL_NUM, and MSQL_BOTH. + take the following values: MSQL_ASSOC, MSQL_NUM, and MSQL_BOTH with + MYSQL_BOTH being the default. Be careful if you are retrieving results from a query that may @@ -41,7 +42,8 @@ See also - msql_fetch_row. + msql_fetch_row and + msql_fetch_object. diff --git a/reference/msql/functions/msql-fetch-field.xml b/reference/msql/functions/msql-fetch-field.xml index 3b9d2c45d6..b55df06ae0 100644 --- a/reference/msql/functions/msql-fetch-field.xml +++ b/reference/msql/functions/msql-fetch-field.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description objectmsql_fetch_field - intquery_identifier + resourcequery_identifier intfield_offset diff --git a/reference/msql/functions/msql-fetch-object.xml b/reference/msql/functions/msql-fetch-object.xml index dc22655447..e5f9f2d4cf 100644 --- a/reference/msql/functions/msql-fetch-object.xml +++ b/reference/msql/functions/msql-fetch-object.xml @@ -1,5 +1,5 @@ - + @@ -11,7 +11,6 @@ intmsql_fetch_object intquery_identifier - intresult_type Returns an object with properties that correspond to the fetched @@ -24,18 +23,14 @@ that you can only access the data by the field names, and not by their offsets (numbers are illegal property names). - - The optional second argument result_type - in msql_fetch_array is a constant and can - take the following values: MSQL_ASSOC, MSQL_NUM, and MSQL_BOTH. - Speed-wise, the function is identical to msql_fetch_array, and almost as quick as msql_fetch_row (the difference is insignificant). - See also: + + See also: msql_fetch_array and msql_fetch_row. diff --git a/reference/msql/functions/msql-fetch-row.xml b/reference/msql/functions/msql-fetch-row.xml index 231324985a..867f83d1da 100644 --- a/reference/msql/functions/msql-fetch-row.xml +++ b/reference/msql/functions/msql-fetch-row.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description arraymsql_fetch_row - intquery_identifier + resourcequery_identifier Returns an array that corresponds to the fetched row, or &false; if diff --git a/reference/msql/functions/msql-field-flags.xml b/reference/msql/functions/msql-field-flags.xml new file mode 100644 index 0000000000..d9a69d29bf --- /dev/null +++ b/reference/msql/functions/msql-field-flags.xml @@ -0,0 +1,42 @@ + + + + + msql_field_flags + Get field flags + + + Description + + stringmsql_field_flags + resourcequery_identifier + intfield_offset + + + msql_field_flags returns the field flags of + the specified field. Currently this is either, "not &null;", + "primary key", a combination of the two or "" (an empty string). + + + + + diff --git a/reference/msql/functions/msql-field-len.xml b/reference/msql/functions/msql-field-len.xml new file mode 100644 index 0000000000..10692804b5 --- /dev/null +++ b/reference/msql/functions/msql-field-len.xml @@ -0,0 +1,41 @@ + + + + + msql_field_len + Get field length + + + Description + + intmsql_field_len + resourcequery_identifier + intfield_offset + + + msql_field_len returns the length of the + specified field or &false; on error. + + + + + diff --git a/reference/msql/functions/msql-field-name.xml b/reference/msql/functions/msql-field-name.xml new file mode 100644 index 0000000000..e3b15d6108 --- /dev/null +++ b/reference/msql/functions/msql-field-name.xml @@ -0,0 +1,45 @@ + + + + + msql_field_name + Get field name + + + Description + + stringmsql_field_name + resourcequery_identifier + intfield + + + msql_field_name returns the name of the + specified field from the result resource + query_identifier. + msql_field_name($result, 2); will + return the name of the second field in the result set associated with + the result identifier. + + + + + diff --git a/reference/msql/functions/msql-field-seek.xml b/reference/msql/functions/msql-field-seek.xml index b46dd44907..0fdd211c36 100644 --- a/reference/msql/functions/msql-field-seek.xml +++ b/reference/msql/functions/msql-field-seek.xml @@ -1,5 +1,5 @@ - + @@ -18,6 +18,9 @@ msql_fetch_field won't include a field offset, this field would be returned. + + This function returns &false; on failure. + See also: msql_fetch_field. diff --git a/reference/msql/functions/msql-field-table.xml b/reference/msql/functions/msql-field-table.xml new file mode 100644 index 0000000000..bce12c954a --- /dev/null +++ b/reference/msql/functions/msql-field-table.xml @@ -0,0 +1,44 @@ + + + + + msql_field_table + Get table name for field + + + Description + + intmsql_field_table + intquery_identifier + intfield + + + Returns the name of the table field was + fetched from. + + + This function returns &false; on failure. + + + + + diff --git a/reference/msql/functions/msql-field-type.xml b/reference/msql/functions/msql-field-type.xml new file mode 100644 index 0000000000..8cbdfa263c --- /dev/null +++ b/reference/msql/functions/msql-field-type.xml @@ -0,0 +1,46 @@ + + + + + msql_field_type + Get field type + + + Description + + stringmsql_field_type + resourcequery_identifier + intfield_offset + + + msql_field_type is similar to the + msql_field_name function. The arguments are + identical, but the field type is returned. This will be one of + "int", "char" or "real". + + + This function returns &false; on failure. + + + + + diff --git a/reference/msql/functions/msql-fieldflags.xml b/reference/msql/functions/msql-fieldflags.xml index d85f54047b..37c6630fa5 100644 --- a/reference/msql/functions/msql-fieldflags.xml +++ b/reference/msql/functions/msql-fieldflags.xml @@ -1,22 +1,15 @@ - + msql_fieldflags - Get field flags + Alias of msql_field_flags Description - - stringmsql_fieldflags - intquery_identifier - inti - - msql_fieldflags returns the field flags of - the specified field. Currently this is either, "not &null;", - "primary key", a combination of the two or "" (an empty string). + This function is an alias of msql_field_flags. diff --git a/reference/msql/functions/msql-fieldlen.xml b/reference/msql/functions/msql-fieldlen.xml index ece49a9ee8..ca5bf8d442 100644 --- a/reference/msql/functions/msql-fieldlen.xml +++ b/reference/msql/functions/msql-fieldlen.xml @@ -1,21 +1,15 @@ - + msql_fieldlen - Get field length + Alias of msql_field_len Description - - intmsql_fieldlen - intquery_identifier - inti - - msql_fieldlen returns the length of the - specified field. + This function is an alias of msql_field_len. diff --git a/reference/msql/functions/msql-fieldname.xml b/reference/msql/functions/msql-fieldname.xml index 32519e0e7e..37a06abee8 100644 --- a/reference/msql/functions/msql-fieldname.xml +++ b/reference/msql/functions/msql-fieldname.xml @@ -1,25 +1,15 @@ - + msql_fieldname - Get field name + Alias of msql_field_name Description - - stringmsql_fieldname - intquery_identifier - intfield - - msql_fieldname returns the name of the - specified field. query_identifier is the - query identifier, and field is the field - index. msql_fieldname($result, 2); will - return the name of the second field in the result associated with - the result identifier. + This function is an alias of msql_field_name. diff --git a/reference/msql/functions/msql-fieldtable.xml b/reference/msql/functions/msql-fieldtable.xml index a6cd30a8f0..a5efd7280b 100644 --- a/reference/msql/functions/msql-fieldtable.xml +++ b/reference/msql/functions/msql-fieldtable.xml @@ -1,21 +1,15 @@ - + msql_fieldtable - Get table name for field + Alias of msql_field_table Description - - intmsql_fieldtable - intquery_identifier - intfield - - Returns the name of the table field was - fetched from. + This function is an alias of msql_field_table. diff --git a/reference/msql/functions/msql-fieldtype.xml b/reference/msql/functions/msql-fieldtype.xml index 90dc26a0c3..cc17f12ede 100644 --- a/reference/msql/functions/msql-fieldtype.xml +++ b/reference/msql/functions/msql-fieldtype.xml @@ -1,23 +1,15 @@ - + msql_fieldtype - Get field type + Alias of msql_field_type Description - - stringmsql_fieldtype - intquery_identifier - inti - - msql_fieldtype is similar to the - msql_fieldname function. The arguments are - identical, but the field type is returned. This will be one of - "int", "char" or "real". + This function is an alias of msql_field_type. diff --git a/reference/msql/functions/msql-free-result.xml b/reference/msql/functions/msql-free-result.xml index c66b8a62c9..f3acf35b4c 100644 --- a/reference/msql/functions/msql-free-result.xml +++ b/reference/msql/functions/msql-free-result.xml @@ -1,5 +1,5 @@ - + @@ -10,7 +10,7 @@ Description intmsql_free_result - intquery_identifier + resourcequery_identifier msql_free_result frees the memory associated @@ -19,6 +19,11 @@ call this function when you want to make sure you don't use too much memory while the script is running. + + For downward compatibility, the alias named + msql_freeresult may be used. This, however, is + deprecated and not recommended. + diff --git a/reference/msql/functions/msql-freeresult.xml b/reference/msql/functions/msql-freeresult.xml index 393f84ca81..860063c193 100644 --- a/reference/msql/functions/msql-freeresult.xml +++ b/reference/msql/functions/msql-freeresult.xml @@ -1,14 +1,16 @@ - + msql_freeresult - Free result memory + Alias of msql_free_result Description - See msql_free_result + + This function is an alias of msql_free_result. + diff --git a/reference/msql/functions/msql-list-dbs.xml b/reference/msql/functions/msql-list-dbs.xml index 69686bcffa..0f5263239c 100644 --- a/reference/msql/functions/msql-list-dbs.xml +++ b/reference/msql/functions/msql-list-dbs.xml @@ -1,5 +1,5 @@ - + @@ -9,15 +9,20 @@ Description - intmsql_list_dbs - + resourcemsql_list_dbs + resourcelink_identifier msql_list_dbs will return a result pointer containing the databases available from the current msql - daemon. Use the msql_dbname function to + daemon. Use the msql_result function to traverse this result pointer. + + For downward compatibility, the alias named + msql_listtables may be used. This, however, is + deprecated and not recommended. + diff --git a/reference/msql/functions/msql-list-fields.xml b/reference/msql/functions/msql-list-fields.xml index 31c762b5b8..06b2e010d9 100644 --- a/reference/msql/functions/msql-list-fields.xml +++ b/reference/msql/functions/msql-list-fields.xml @@ -1,5 +1,5 @@ - + @@ -9,26 +9,24 @@ Description - intmsql_list_fields + resourcemsql_list_fields stringdatabase stringtablename + resourcelink_identifier msql_list_fields retrieves information about - the given tablename. Arguments are the database name and the - table name. A result pointer is returned which can be used with - msql_fieldflags, - msql_fieldlen, - msql_fieldname, and - msql_fieldtype. A query identifier is a - positive integer. The function returns -1 if a - error occurs. A string describing the error will be placed in - $phperrmsg, and unless the function was called - as @msql_list_fields() then this error string - will also be printed out. + the given tablename. The returned result set can + be traversed with any function that fetches result sets, such as + msql_fetch_array. - See also msql_error. + This function returns &false; on failure. + + + For downward compatibility, the alias named + msql_listfields may be used. This, however, is + deprecated and not recommended. diff --git a/reference/msql/functions/msql-list-tables.xml b/reference/msql/functions/msql-list-tables.xml index 37192743fb..7c00914e68 100644 --- a/reference/msql/functions/msql-list-tables.xml +++ b/reference/msql/functions/msql-list-tables.xml @@ -1,5 +1,5 @@ - + @@ -9,15 +9,23 @@ Description - intmsql_list_tables + resourcemsql_list_tables stringdatabase + resourcelink_identifier - msql_list_tables takes a database name and - result pointer much like the msql - function. The msql_tablename function should - be used to extract the actual table names from the result - pointer. + msql_list_tables lists the tables on the specified + database. It returns a result set which may be + traversed with any function that fetches result sets, such as + msql_fetch_array. + + + This function returns &false; on failure. + + + For downward compatibility, the alias named + msql_listtables may be used. This, however, is + deprecated and not recommended. diff --git a/reference/msql/functions/msql-listdbs.xml b/reference/msql/functions/msql-listdbs.xml index 41295f349b..8e29f6e913 100644 --- a/reference/msql/functions/msql-listdbs.xml +++ b/reference/msql/functions/msql-listdbs.xml @@ -1,15 +1,15 @@ - + msql_listdbs - List mSQL databases on server + Alias of msql_list_dbs Description - See msql_list_dbs. + This function is an alias of msql_list_dbs. diff --git a/reference/msql/functions/msql-listfields.xml b/reference/msql/functions/msql-listfields.xml index bc9a39b1a5..ffdb082c6c 100644 --- a/reference/msql/functions/msql-listfields.xml +++ b/reference/msql/functions/msql-listfields.xml @@ -1,15 +1,15 @@ - + msql_listfields - List result fields + Alias of msql_list_fields Description - See msql_list_fields. + This function is an alias of msql_list_fields. diff --git a/reference/msql/functions/msql-listtables.xml b/reference/msql/functions/msql-listtables.xml index c7568e5388..0019c01327 100644 --- a/reference/msql/functions/msql-listtables.xml +++ b/reference/msql/functions/msql-listtables.xml @@ -1,15 +1,15 @@ - + msql_listtables - List tables in an mSQL database + Alias of msql_list_tables Description - See msql_list_tables. + This function is an alias of msql_list_tables. diff --git a/reference/msql/functions/msql-num-fields.xml b/reference/msql/functions/msql-num-fields.xml index 8c2d4156d8..3f4dccde75 100644 --- a/reference/msql/functions/msql-num-fields.xml +++ b/reference/msql/functions/msql-num-fields.xml @@ -1,5 +1,5 @@ - + @@ -10,15 +10,19 @@ Description intmsql_num_fields - intquery_identifier + resourcequery_identifier msql_num_fields returns the number of fields in a result set. - See also: msql, - msql_query, + For downwards compatability, the alias named + msql_numfields may be used. This, however, is + deprecated and not recommended. + + + See also: msql_query, msql_fetch_field, and msql_num_rows. diff --git a/reference/msql/functions/msql-num-rows.xml b/reference/msql/functions/msql-num-rows.xml index 9e2fd1b595..ea42f91f2a 100644 --- a/reference/msql/functions/msql-num-rows.xml +++ b/reference/msql/functions/msql-num-rows.xml @@ -1,5 +1,5 @@ - + @@ -17,9 +17,13 @@ a result set. - See also: msql, - msql_query, and - msql_fetch_row. + For downwards compatability, the alias named + msql_numrows may be used. This, however is + deprecated and not recommended. + + + See also: msql_db_query and + msql_query. diff --git a/reference/msql/functions/msql-numfields.xml b/reference/msql/functions/msql-numfields.xml index f5d6ec909b..c546dba784 100644 --- a/reference/msql/functions/msql-numfields.xml +++ b/reference/msql/functions/msql-numfields.xml @@ -1,19 +1,15 @@ - + msql_numfields - Get number of fields in result + Alias of msql_num_fields Description - - intmsql_numfields - intquery_identifier - - Identical to msql_num_fields. + This function is an alias of msql_num_fields. diff --git a/reference/msql/functions/msql-numrows.xml b/reference/msql/functions/msql-numrows.xml index a9eaf6402c..ddb469cfdf 100644 --- a/reference/msql/functions/msql-numrows.xml +++ b/reference/msql/functions/msql-numrows.xml @@ -1,19 +1,15 @@ - + msql_numrows - Get number of rows in result + Alias of msql_num_rows Description - - intmsql_numrows - - - Identical to msql_num_rows. + This function is an alias of msql_num_rows. diff --git a/reference/msql/functions/msql-pconnect.xml b/reference/msql/functions/msql-pconnect.xml index 6859a9b388..a47863f8b4 100644 --- a/reference/msql/functions/msql-pconnect.xml +++ b/reference/msql/functions/msql-pconnect.xml @@ -1,5 +1,5 @@ - + @@ -10,15 +10,9 @@ Description intmsql_pconnect - string - server - - string - username - - string - password - + stringserver + stringusername + stringpassword msql_pconnect acts very much like @@ -40,9 +34,6 @@ Returns a positive mSQL persistent link identifier on success, or &false; on error. - - This type of links is therefore called 'persistent'. - diff --git a/reference/msql/functions/msql-query.xml b/reference/msql/functions/msql-query.xml index 7bfad6b1c2..33ccb58b81 100644 --- a/reference/msql/functions/msql-query.xml +++ b/reference/msql/functions/msql-query.xml @@ -1,5 +1,5 @@ - + @@ -9,9 +9,9 @@ Description - intmsql_query + resourcemsql_query stringquery - intlink_identifier + resourcelink_identifier msql_query sends a query to the currently @@ -49,7 +49,7 @@ while ($row = msql_fetch_array($result)) { See also - msql, + msql_db_query, msql_select_db, and msql_connect. diff --git a/reference/msql/functions/msql-regcase.xml b/reference/msql/functions/msql-regcase.xml index 692ff2926a..c87756b6ac 100644 --- a/reference/msql/functions/msql-regcase.xml +++ b/reference/msql/functions/msql-regcase.xml @@ -1,16 +1,15 @@ - + msql_regcase - - Make regular expression for case insensitive match - + Alias of sql_regcase Description - See sql_regcase. + + This function is an alias of sql_regcase. diff --git a/reference/msql/functions/msql-result.xml b/reference/msql/functions/msql-result.xml index abae7e43a6..07a201e42c 100644 --- a/reference/msql/functions/msql-result.xml +++ b/reference/msql/functions/msql-result.xml @@ -1,5 +1,5 @@ - + @@ -9,10 +9,10 @@ Description - intmsql_result - intquery_identifier - inti - mixedfield + stringmsql_result + resourcequery_identifier + introw + mixedfield Returns the contents of the cell at the row and offset in the @@ -30,7 +30,7 @@ When working on large result sets, you should consider using one of the functions that fetch an entire row (specified below). As these functions return the contents of multiple cells in one - function call, they're MUCH quicker than + function call, they are often much quicker than msql_result. Also, note that specifying a numeric offset for the field argument is much quicker than specifying a fieldname or tablename.fieldname argument. @@ -41,6 +41,12 @@ msql_fetch_array, and msql_fetch_object. + + For downward compatibility, the aliases named + msql, msql_tablename, and + msql_dbname may be used. This, however, is + deprecated and not recommended. + diff --git a/reference/msql/functions/msql-select-db.xml b/reference/msql/functions/msql-select-db.xml index 7f1dcdf63f..ccfdd53c25 100644 --- a/reference/msql/functions/msql-select-db.xml +++ b/reference/msql/functions/msql-select-db.xml @@ -1,5 +1,5 @@ - + @@ -9,25 +9,30 @@ Description - intmsql_select_db + boolmsql_select_db stringdatabase_name - intlink_identifier + resourcelink_identifier - - Returns &true; on success, &false; on error. - msql_select_db sets the current active - database on the server that's associated with the specified link - identifier. If no link identifier is specified, the last opened - link is assumed. If no link is open, the function will try to - establish a link as if msql_connect was - called, and use it. + database on the server that's associated with the specified + link_identifier. If no link identifier is + specified, the last opened link is assumed. If no link is open, the + function will try to establish a link as if + msql_connect was called, and use it. + + + &return.success; - Every subsequent call to msql_query will be + Subsequent calls to msql_query will be made on the active database. + + For downward compatibility, the alias named + msql_selectdb may be used. This, however, is + deprecated and not recommended. + See also msql_connect, diff --git a/reference/msql/functions/msql-selectdb.xml b/reference/msql/functions/msql-selectdb.xml index 00946c092e..a71ebeae19 100644 --- a/reference/msql/functions/msql-selectdb.xml +++ b/reference/msql/functions/msql-selectdb.xml @@ -1,14 +1,15 @@ - + msql_selectdb - Select mSQL database + Alias of msql_select_db Description - See msql_select_db. + + This function is an alias of msql_select_db. diff --git a/reference/msql/functions/msql-tablename.xml b/reference/msql/functions/msql-tablename.xml index 1c7d7b5ad5..2f5a771a6a 100644 --- a/reference/msql/functions/msql-tablename.xml +++ b/reference/msql/functions/msql-tablename.xml @@ -1,41 +1,15 @@ - + msql_tablename - Get table name of field + Alias of msql_result Description - - stringmsql_tablename - intquery_identifier - intfield - - - msql_tablename takes a result pointer - returned by the msql_list_tables function as - well as an integer index and returns the name of a table. The - msql_numrows function may be used to - determine the number of tables in the result pointer. - - <function>msql_tablename</function> example - -"; - $i++; -} -?> -]]> - - + + This function is an alias of msql_result. diff --git a/reference/msql/functions/msql.xml b/reference/msql/functions/msql.xml index 86174b35c9..76bce5735b 100644 --- a/reference/msql/functions/msql.xml +++ b/reference/msql/functions/msql.xml @@ -1,30 +1,15 @@ - + msql - Send mSQL query + Alias of msql_db_query Description - - intmsql - stringdatabase - stringquery - intlink_identifier - - - Returns a positive mSQL query identifier to the query result, or - &false; on error. - - msql selects a database and executes a query - on it. If the optional link identifier isn't specified, the - function will try to find an open link to the mSQL server and if - no such link is found it'll try to create one as if - msql_connect was called with no arguments - (see msql_connect). + This function is an alias of msql_db_query.