diff --git a/doc/br/manual.html b/doc/br/manual.html
index 06ab4f1..0e8f07c 100644
--- a/doc/br/manual.html
+++ b/doc/br/manual.html
@@ -14,7 +14,7 @@
- LuaSQL
+ LuaSQL
Conectividade de banco de dados para a linguagem de programação Lua
@@ -139,16 +139,16 @@ env = luasql.jdbc ("com.mysql.jdbc.Driver")
Métodos
-
- env:close()
- Fecha o ambiente env. Só é bem sucedido se todas as suas
+
+ env:close()- Fecha o ambiente
env. Só é bem sucedido se todas as suas
conexões já tiverem sido fechadas anteriormente.
Retorna: true, em caso de sucesso; false, quando o ambiente
já estiver fechado.
-
env:connect(sourcename[,username[,password]])
- Conecta à fonte de dados especificada em sourcename usando
+ env:connect(sourcename[,username[,password]])- Conecta à fonte de dados especificada em
sourcename usando
username e password se eles são fornecidos.
O sourcename pode variar de acordo com cada driver.
Alguns usam simplesmente o nome do banco de dados, como PostgreSQL, MySQL e SQLite;
@@ -159,8 +159,8 @@ env = luasql.jdbc ("com.mysql.jdbc.Driver")
Veja também: PostgreSQL e
MySQL.
Retorna: uma conexão.
-
+
+
Conexão
@@ -171,43 +171,43 @@ o método environment:connect.
Métodos
-
- conn:close()
- Fecha a conexão conn. Só é bem sucedido se todos
+
+ conn:close()- Fecha a conexão
conn. Só é bem sucedido se todos
os seus cursores tiverem sido fechados anteriormente.
Retorna: true, em caso de sucesso; false, quando a
conexão já estiver fechada.
-
conn:commit()
- Efetua a transação corrente. Esse atributo pode não funcionar
+ conn:commit()- Efetua a transação corrente. Esse atributo pode não funcionar
em sistemas de banco de dados que não implementam transações.
Retorna: true, em caso de sucesso; false, quando
a operação não pode ser realizada ou não está implementada.
- conn:execute(statement)
- Executa o statement SQL dado.
+ conn:execute(statement)- Executa o
statement SQL dado.
Retorna: o cursor, se houver resultados, ou o número
de registros afetados de alguma forma pelo comando.
- conn:rollback()
- Desfaz a transação corrente. Esse atributo pode não funcionar
+ conn:rollback()- Desfaz a transação corrente. Esse atributo pode não funcionar
em sistemas de banco de dados que não implementam transações.
Retorna: true, em caso de sucesso; false, quando
a operação não pode ser realizada ou não está implementada.
- conn:setautocommit(boolean)
- Ativa ou desativa o modo "auto commit". Esse atributo pode não funcionar em sistemas
+ conn:setautocommit(boolean)- Ativa ou desativa o modo "auto commit". Esse atributo pode não funcionar em sistemas
de banco de dados que não implementam transações. Em sistemas de banco
de dados que não trabalham com o conceito de " modo auto commit", mas que implementam
transações, esse mecanismo é implementado pelo driver.
Retorna: true, em caso de sucesso; false, quando
a operação não pode ser realizada ou não está implementada.
-
+
+
Cursor
@@ -220,15 +220,15 @@ e Oracle.
Métodos
-
- cur:close()
- Fecha esse cursor.
+
+ cur:close()- Fecha esse cursor.
Retorna: true, em caso de sucesso; false, quando o cursor
já está fechado.
-
cur:fetch([table[,modestring]])
- Recupera o próximo registro de resultados.
+ cur:fetch([table[,modestring]])- Recupera o próximo registro de resultados.
Se fetch é chamado sem parâmetros, os resultados
consistem em uma lista de valores. Se fetch é
chamado com uma tabela, os resultados são copiados para a tabela e a tabela
@@ -236,10 +236,11 @@ e Oracle.
parâmetro opcional de modo (modestring): uma seqüência
de caracteres indicando como deve ser construída a tabela de resultados.
A seqüência de caracteres do modo pode conter:
-
- - "n", a tabela resultante terá índices numéricos (padrão)
- - "a", a tabela resultante terá índices alfanuméricos
-
+
+ - "n"
- a tabela resultante terá índices numéricos (padrão)
+ - "a"
- a tabela resultante terá índices alfanuméricos
+
+
Os índices numéricos representam as posições dos
campos no comando selecionado; os índices alfanuméricos representam
os nomes dos campos.
@@ -253,16 +254,16 @@ e Oracle.
Retorna: dados, como descrito acima, ou nil se não existem mais registros.
Note que esse método pode retornar nil como um resultado válido
(equivalente a null).
- cur:getcolnames()
- Retorna: uma tabela com os nomes das colunas.
- cur:getcolnames()- Retorna: uma tabela com os nomes das colunas.
+
- cur:getcoltypes()
- Retorna: uma tabela com os tipos das colunas.
-
+ cur:getcoltypes()
+ Retorna: uma tabela com os tipos das colunas.
+
+
@@ -271,9 +272,9 @@ e Oracle.
Além das funcionalidades básicas oferecidas por todos os drivers
(ver manual), o driver Postgres ainda oferece funcionalidades extras:
-
- env:connect(sourcename[,username[,password[,hostname[,port]]]])
- No driver PostgreSQL, esse método tem dois outros parâmetros que indicam
+
+ env:connect(sourcename[,username[,password[,hostname[,port]]]])- No driver PostgreSQL, esse método tem dois outros parâmetros que indicam
o
hostname e a port a serem utilizados na conexão.
O primeiro parâmetro também pode conter todas as informações
de conexão, como é dito na documentação
@@ -281,13 +282,13 @@ e Oracle.
(ex. environment:connect("dbname=<name> user=<username>"))
Veja também: ambiente
Retorna: uma conexão
-
cur:numrows()
- Veja também: cursor
+ cur:numrows()- Veja também: cursor
Retorna: o número de registros no resultado da busca.
-
+
+
MySQL
@@ -295,14 +296,14 @@ e Oracle.
Além das funcionalidades básicas oferecidas por todos os drivers
(ver manual), o driver MySQL ainda oferece uma funcionalidade extra:
-
- env:connect(sourcename[,username[,password[,hostname[,port]]]])
- No driver MySQL, esse método tem dois outros parâmetros que indicam o
+
+ env:connect(sourcename[,username[,password[,hostname[,port]]]])- No driver MySQL, esse método tem dois outros parâmetros que indicam o
hostname e a port a serem utilizados na conexão.
Veja também: ambiente
Retorna: uma conexão
-
+
+
Nota: Esse driver é compatível com a versão 4.0 e 4.1 (alpha) do
MySQL API. Apenas as versões 4.1 oferecem suporte para transações que usam tabelas
@@ -314,12 +315,12 @@ BDB ou INNODB. Com a versão 4.0 ou sem um desses tipos de tabelas, os m&e
Além das funcionalidades básicas oferecidas por todos os drivers
(ver manual), o driver Oracle ainda oferece uma funcionalidade extra:
-
- cur:numrows()
- Veja também: cursor
+
+ cur:numrows()- Veja também: cursor
Retorna: o número de registros no resultado da pesquisa.
-
+
+
@@ -328,7 +329,7 @@ BDB ou INNODB. Com a versão 4.0 ou sem um desses tipos de tabelas, os m&e
- $Id: manual.html,v 1.2 2005/05/02 12:40:16 carregal Exp $
+ $Id: manual.html,v 1.3 2005/05/22 18:51:52 tuler Exp $
diff --git a/doc/us/manual.html b/doc/us/manual.html
index 9d917ea..7b0a320 100644
--- a/doc/us/manual.html
+++ b/doc/us/manual.html
@@ -14,7 +14,7 @@
- LuaSQL
+ LuaSQL
Database connectivity for the Lua programming language
@@ -159,27 +159,27 @@ env = luasql.jdbc ("com.mysql.jdbc.Driver")
Methods
-
+
-
env:close()
-Closes the environment env.
-Only successful if all connections pertaining to it were closed first.
-Returns: true in case of success; false when
-the object is already closed.env:close()- Closes the environment
env.
+ Only successful if all connections pertaining to it were closed first.
+ Returns: true in case of success; false when
+ the object is already closed.
+
+ env:connect(sourcename[,username[,password]])- Connects to a data source specified in
sourcename using
+ username and password if they are supplied.
+ The sourcename may vary according to each driver.
+ Some use a simple database name, like PostgreSQL, MySQL and SQLite;
+ the ODBC driver expects the name of the DSN;
+ the Oracle driver expects the service name;
+ the JDBC driver expects a string like "jdbc:<database system>://<database name>", which is specific for each driver.
+ See also: PostgreSQL,
+ and MySQL extensions.
+ Returns: a connection object.
-env:connect(sourcename[,username[,password]])
-Connects to a data source specified in sourcename using
-username and password if they are supplied.
-The sourcename may vary according to each driver.
-Some use a simple database name, like PostgreSQL, MySQL and SQLite;
-the ODBC driver expects the name of the DSN;
-the Oracle driver expects the service name;
-the JDBC driver expects a string like "jdbc:<database system>://<database name>", which is specific for each driver.
-See also: PostgreSQL,
- and MySQL extensions.
-Returns: a connection object.
+
Connection Objects
@@ -192,48 +192,48 @@ method.
Methods
-
+
-
conn:close()
-Closes the connection conn.
-Only successful if all cursors pertaining to it were closed first.
-Returns: true in case of success and false when
-the object is already closed.conn:close()- Closes the connection
conn.
+ Only successful if all cursors pertaining to it were closed first.
+ Returns: true in case of success and false when
+ the object is already closed.
+
+
+ conn:commit()- Commits the current transaction.
+ This feature might not work on database systems that do not implement
+ transactions.
+ Returns: true in case of success and false when
+ the operation could not be performed or when it is not implemented.
+
+
+ conn:execute(statement)- Executes the given SQL
statement.
+ Returns: a cursor object
+ if there are results, or the number of rows affected by the command otherwise.
+
+
+ conn:rollback()- Rolls back the current transaction.
+ This feature might not work on database systems that do not implement
+ transactions.
+ Returns: true in case of success and false when
+ the operation could not be performed or when it is not implemented.
+
+
+ conn:setautocommit(boolean)- Turns on or off the "auto commit" mode.
+ This feature might not work on database systems that do not implement
+ transactions.
+ On database systems that do not have the concept of "auto commit mode",
+ but do implement transactions, this mechanism is implemented by the driver.
+
+ Returns: true in case of success and false when
+ the operation could not be performed or when it is not implemented.
-
-conn:commit()
-Commits the current transaction.
-This feature might not work on database systems that do not implement
-transactions.
-Returns: true in case of success and false when
-the operation could not be performed or when it is not implemented.conn:execute(statement)
-Executes the given SQL statement.
-Returns: a cursor object
-if there are results, or the number of rows affected by the command otherwise.conn:rollback()
-Rolls back the current transaction.
-This feature might not work on database systems that do not implement
-transactions.
-Returns: true in case of success and false when
-the operation could not be performed or when it is not implemented.conn:setautocommit(boolean)
-Turns on or off the "auto commit" mode.
-This feature might not work on database systems that do not implement
-transactions.
-On database systems that do not have the concept of "auto commit mode",
-but do implement transactions, this mechanism is implemented by the driver.
-
-Returns: true in case of success and false when
-the operation could not be performed or when it is not implemented.
+
Cursor Objects
@@ -247,49 +247,51 @@ and Oracle extensions.
Methods
-
+
-
cur:close()
-Closes this cursor.
-Returns: true in case of success and false when
-the object is already closed.cur:close()- Closes this cursor.
+ Returns: true in case of success and false when
+ the object is already closed.
+
+
+ cur:fetch([table[,modestring]])- Retrieves the next row of results.
+ If fetch is called without parameters,
+ the results will be returned to the caller directly.
+ If fetch is called with a table, the results will be copied
+ into the table and this table will be returned (for convenience).
+ In this case, an optional mode parameter can be used.
+ It is just a string indicating how the result table should be made.
+ The mode string can contain:
+
+ - "n"
- the resulting table will have numerical indices (default)
+ - "a"
- the resulting table will have alphanumerical indices
+
+
+ The numerical indices are the positions of the fields in the select
+ statement;
+ the alphanumerical indices are the names of the fields.
+ The optional table parameter is a table that should be
+ used to store the next row.
+ This allows the use of a unique table for many fetches which
+ can improve the overall performance.
+ There is no guarantee about the types of the results, they can be converted to adequate Lua types by the driver or not.
+ In the current implementation,
+ the PostgreSQL and MySQL drivers returns all values as strings
+ while the ODBC and Oracle drivers converts them to Lua types.
+ Returns: data, as above, or nil if there are no more rows.
+ Note that this method could return nil as a valid result.
+
+
+ cur:getcolnames()- Returns: a list (table) of column names.
+
+
+ cur:getcoltypes()- Returns: a list (table) of column types.
-
-cur:fetch([table[,modestring]])
-Retrieves the next row of results.
-If fetch is called without parameters,
-the results will be returned to the caller directly.
-If fetch is called with a table, the results will be copied
-into the table and this table will be returned (for convenience).
-In this case, an optional mode parameter can be used.
-It is just a string indicating how the result table should be made.
-The mode string can contain:
-
- - "n" the resulting table will have numerical indices (default)
- - "a" the resulting table will have alphanumerical indices
-
-The numerical indices are the positions of the fields in the select
-statement;
-the alphanumerical indices are the names of the fields.
-The optional table parameter is a table that should be
-used to store the next row.
-This allows the use of a unique table for many fetches which
-can improve the overall performance.
-There is no guarantee about the types of the results, they can be converted to adequate Lua types by the driver or not.
-In the current implementation,
-the PostgreSQL and MySQL drivers returns all values as strings
-while the ODBC and Oracle drivers converts them to Lua types.
-Returns: data, as above, or nil if there are no more rows.
-Note that this method could return nil as a valid result.cur:getcolnames()
-Returns: a list (table) of column names.cur:getcoltypes()
-Returns: a list (table) of column types.
+
@@ -298,21 +300,21 @@ Returns: a list (table) of column types.
Besides the basic functionality provided by all drivers (see manual),
the Postgres driver also offers these extra features:
-
- env:connect(sourcename[,username[,password[,hostname[,port]]]])
- In the PostgreSQL driver, this method has two other optional parameters
+
+ env:connect(sourcename[,username[,password[,hostname[,port]]]])- In the PostgreSQL driver, this method has two other optional parameters
that indicate the hostname and port to connect.
Also, the first parameter can contain all connection information,
as stated in the documentation for
PQconnectdb function
in the PostgreSQL manual
(e.g. environment:connect("dbname=<name> user=<username>"))
See also: environment objects
- Returns: a connection object
cur:numrows()
- See also: cursor objects
- Returns: the number of rows in the query result.
+ cur:numrows()
+ See also: cursor objects
+ Returns: the number of rows in the query result.
+
MySQL Extensions
@@ -320,13 +322,13 @@ the Postgres driver also offers these extra features:
Besides the basic functionality provided by all drivers (see manual),
the MySQL driver also offers these extra features:
-
- env:connect(sourcename[,username[,password[,hostname[,port]]]])
- In the MySQL driver, this method has two other optional parameters
+
+ env:connect(sourcename[,username[,password[,hostname[,port]]]])- In the MySQL driver, this method has two other optional parameters
that indicate the hostname and port to connect.
See also: environment objects
- Returns: a connection object
+ Returns: a connection object
+
Note: This driver is compatible to version 4.0 and 4.1 (alpha) of
MySQL API. Only version 4.1 provides support for transactions by using
@@ -341,11 +343,11 @@ methods commit, rollback and
Besides the basic functionality provided by all drivers (see manual),
the Oracle driver also offers this extra feature:
-
- cur:numrows()
- See also: cursor objects
- Returns: the number of rows in the query result.
+
+ cur:numrows()- See also: cursor objects
+ Returns: the number of rows in the query result.
+
@@ -354,7 +356,7 @@ the Oracle driver also offers this extra feature:
- $Id: manual.html,v 1.10 2005/03/22 22:47:24 tuler Exp $
+ $Id: manual.html,v 1.11 2005/05/22 18:51:52 tuler Exp $
