diff --git a/doc/precompiled/sql b/doc/precompiled/sql index 8a88950f78dbd922152e84d3c21af195ab9870ec..6a90752d69a4f260bb2d7307efceab45de8c7ac6 100644 --- a/doc/precompiled/sql +++ b/doc/precompiled/sql @@ -1,19 +1,19 @@ NAME - /precompiled/sql - Generic interface to SQL databases (ALPHA) + Sql.sql - Generic interface to SQL databases (ALPHA) DESCRIPTION - /precompiled/sql is a precompiled Pike program. It enables access + Sql.sql is a program in the Sql module. It enables access to SQL databases from within Pike. NOTA BENE To use this module you need at least one specific SQL-module e.g. - /precompiled/sql/mysql or /precompiled/sql/msql. + Mysql.mysql or Msql.msql. KEYWORDS sql, database SEE ALSO - /precompiled/sql/mysql, /precompiled/sql/msql + Mysql.mysql, Msql.msql ============================================================================ @@ -23,24 +23,24 @@ NAME SYNTAX #include <sql.h> - object(Sql) Sql(); + object(sql) sql(); or - object(Sql) Sql(object obj); + object(sql) sql(object obj); or - object(Sql) Sql(object obj, string database); + object(sql) sql(object obj, string database); or - object(Sql) Sql(string hostname); + object(sql) sql(string hostname); or - object(Sql) Sql(string hostname, string database); + object(sql) sql(string hostname, string database); or - object(Sql) Sql(string hostname, string database, string user); + object(sql) sql(string hostname, string database, string user); or - object(Sql) Sql(string hostname,string database, + object(sql) sql(string hostname,string database, string user, string password); DESCRIPTION To access a database, you must first connect to it. This is - done with the function Sql(). + done with the function sql(). If the first argument is an object, access to the SQL-database will go through that object. @@ -66,14 +66,16 @@ EXAMPLE { /* First: Do it with the first available SQL-server */ - object(Sql) sql = Sql(0, "test"); + object(sql) sql_connection = sql(0, "test"); - write(sprintf("Sql: %O\n", sql->query("select * from db"))); + write(sprintf("sql: %O\n", + sql_connection->query("select * from db"))); /* Second: Use the Mysql-server */ - sql = Sql(Mysql(), "test"); + sql_connection = sql(mysql(), "test"); - write(sprintf("Mysql: %O\n", sql->query("select * from db"))); + write(sprintf("mysql: %O\n", + sql_connection->query("select * from db"))); } SEE ALSO @@ -137,7 +139,7 @@ NAME SYNTAX #include <sql.h> - object(Sql_result) sql->big_query(string q); + object(sql_result) sql->big_query(string q); DESCRIPTION This function sends an SQL query to the underlying SQL-server. The @@ -147,7 +149,7 @@ DESCRIPTION result (e.g. INSERT or similar). SEE ALSO - sql->query, /precompiled/sql_result + sql->query, Sql.sql_result ============================================================================ @@ -329,3 +331,4 @@ NOTA BENE SEE ALSO sql->list_dbs, sql->list_tables, sql_result->fetch_fields + diff --git a/doc/precompiled/sql_result b/doc/precompiled/sql_result index b41cfeef54a283c8a9b32480ce80cd6f27d10a01..72dad603b86af194ce8b99a84f96b3f406cb44e5 100644 --- a/doc/precompiled/sql_result +++ b/doc/precompiled/sql_result @@ -1,16 +1,16 @@ NAME - /precompiled/sql_result - generic SQL result from a big_query (ALPHA) + Sql.sql_result - generic SQL result from a big_query (ALPHA) DESCRIPTION - /precompiled/sql_result is a precompiled Pike program. It usually + Sql.sql_result is a precompiled Pike program. It usually contains the result from an SQL-query. It acts as a wrapper for - e.g. /precompiled/sql/mysql_result and /precompiled/sql_msql_result. + e.g. Mysql.mysql_result and Msql.msql_result. KEYWORDS sql, database SEE ALSO - /precompiled/sql/mysql_result, /precompiled/sql/msql_result + Mysql.mysql_result, Msql.msql_result ============================================================================ @@ -20,11 +20,11 @@ NAME SYNTAX #include <sql.h> - object(Sql_result) Sql_result(object res); + object(sql_result) Sql_result(object res); or - object(Sql_result) Sql_result(array(mapping(string:mixed)) res); + object(sql_result) Sql_result(array(mapping(string:mixed)) res); or - object(Sql_result) sql->big_query(string q); + object(sql_result) sql->big_query(string q); DESCRIPTION The first two functions generate a Sql_result object from an @@ -32,7 +32,7 @@ DESCRIPTION SQL-query q. SEE ALSO - sql->big_query, /precompiled/sql + sql->big_query, Sql.sql ============================================================================ diff --git a/src/modules/Mysql/doc/mysql b/src/modules/Mysql/doc/mysql index 8e11cefe880f1606993e05bb220d75cabed3e657..0124419dbf479062ad493c637434f815afa93b5e 100644 --- a/src/modules/Mysql/doc/mysql +++ b/src/modules/Mysql/doc/mysql @@ -1,10 +1,10 @@ NAME - /precompiled/sql/mysql - Interface to the Mysql database (ALPHA) + Mysql.mysql - Interface to the Mysql database (ALPHA) DESCRIPTION - /precompiled/sql/mysql is a pre-compiled Pike program. It enables - access to the Mysql database from within Pike. /precompiled/sql/mysql - is a part of the mysql module. + Mysql.mysql is a pre-compiled Pike program. It enables + access to the Mysql database from within Pike. Mysql.mysql + is a part of the Mysql module. Mysql is available from http://www.tcx.se/ . @@ -19,20 +19,20 @@ NAME SYNTAX #include <mysql.h> - object(Mysql) Mysql(); + object(mysql) mysql(); or - object(Mysql) Mysql(string hostname); + object(mysql) mysql(string hostname); or - object(Mysql) Mysql(string hostname, string database); + object(mysql) mysql(string hostname, string database); or - object(Mysql) Mysql(string hostname, string database, string user); + object(mysql) mysql(string hostname, string database, string user); or - object(Mysql) Mysql(string hostname, string database, string user, + object(mysql) mysql(string hostname, string database, string user, string password); DESCRIPTION To access the Mysql database, you must first connect to it. This is - done with the function Mysql(). + done with the function mysql(). If you give no argument, or give "" as hostname it will connect with a UNIX-domain socket, which is a big performance gain. @@ -106,12 +106,12 @@ SYNTAX DESCRIPTION This function sends an SQL query to the Mysql-server. The result - of the query is returned as a /precompiled/sql/mysql_result object. + of the query is returned as a Mysql.mysql_result object. Returns 0 if the query didn't return any result (e.g. INSERT or similar). SEE ALSO - /precompiled/sql/mysql_result + Mysql.mysql_result ============================================================================ @@ -261,9 +261,9 @@ NAME SYNTAX #include <mysql.h> - object(Mysql_result) mysql->list_dbs(); + object(mysql_result) mysql->list_dbs(); or - object(Mysql_result) mysql->list_dbs(string wild); + object(mysql_result) mysql->list_dbs(string wild); DESCRIPTION Returns a table containing the names of all databases in the @@ -272,7 +272,7 @@ DESCRIPTION SEE ALSO mysql->list_tables, mysql->list_fields, mysql->list_processes, - /precompiled/sql/mysql_result + Mysql.mysql_result ============================================================================ @@ -282,9 +282,9 @@ NAME SYNTAX #include <mysql.h> - object(Mysql_result) mysql->list_tables(); + object(mysql_result) mysql->list_tables(); or - object(Mysql_result) mysql->list_tables(string wild); + object(mysql_result) mysql->list_tables(string wild); DESCRIPTION Returns a table containing the names of all tables in the current @@ -293,7 +293,7 @@ DESCRIPTION SEE ALSO mysql->list_dbs, mysql->list_fields, mysql->list_processes, - /precompiled/sql/mysql_result + Mysql.mysql_result ============================================================================ @@ -349,7 +349,7 @@ NAME SYNTAX #include <mysql.h> - object(Mysql_result) mysql->list_processes(); + object(mysql_result) mysql->list_processes(); DESCRIPTION Returns a table containing the names of all processes in the @@ -357,7 +357,7 @@ DESCRIPTION SEE ALSO mysql->list_dbs, mysql->list_tables, mysql->list_fields, - /precompiled/sql/mysql_result + Mysql.mysql_result ============================================================================ diff --git a/src/modules/Mysql/doc/mysql_result b/src/modules/Mysql/doc/mysql_result index f62e5baa142f76ee1d89d7a964bc3fd227afea74..d4fc8f1b5c910dccffb7f7a6895caa469a85a931 100644 --- a/src/modules/Mysql/doc/mysql_result +++ b/src/modules/Mysql/doc/mysql_result @@ -1,10 +1,10 @@ NAME - /precompiled/sql/mysql_result - result of an Mysql query (ALPHA) + Myslq.mysql_result - result of an Mysql query (ALPHA) DESCRIPTION - /precompiled/sql/mysql_result is a pre-compiled Pike program. It - contains the result of a Mysql-query. /precompiled/sql/mysql_result - is a part of the mysql module. + Mysql.mysql_result is a pre-compiled Pike program. It + contains the result of a Mysql-query. Mysql.mysql_result + is a part of the Mysql module. Mysql is available from http://www.tcx.se/ . @@ -12,7 +12,7 @@ KEYWORDS sql, database SEE ALSO - /precompiled/sql/mysql + Mysql.mysql ============================================================================ @@ -22,24 +22,24 @@ NAME SYNTAX #include <mysql.h> - object(Mysql_result) mysql->query(string q); + object(mysql_result) mysql->query(string q); or - object(Mysql_result) mysql->list_dbs(); + object(mysql_result) mysql->list_dbs(); or - object(Mysql_result) mysql->list_dbs(string wild); + object(mysql_result) mysql->list_dbs(string wild); or - object(Mysql_result) mysql->list_tables(); + object(mysql_result) mysql->list_tables(); or - object(Mysql_result) mysql->list_tables(string wild); + object(mysql_result) mysql->list_tables(string wild); or - object(Mysql_result) mysql->list_processes(); + object(mysql_result) mysql->list_processes(); DESCRIPTION Creates a Mysql result table. SEE ALSO mysql->query, mysql->list_dbs, mysql->list_tables, - mysql->list_processes, /precompiled/sql/mysql + mysql->list_processes, Mysql.mysql ============================================================================