Connection aux bases de données pour le language de programmation Lua

LuaSQL

• Accueil
  • Vue d'ensemble
  • Statut
  • Téléchargement
  • Crédits
  • Contactez-nous
• Manuel
  • Introduction
  • Compilation
  • Installation
  • Gestion des erreurs
  • Pilotes
  • Environnement
  • Connexion
  • Curseur
  • PostgreSQL
  • MySQL
  • Oracle
  • SQLite3
• Examples
• Historique
• Projet
  • Suivis de Bugs
• Licence

Introduction

LuaSQL is a simple interface from Lua to a number of database management systems. It includes a set of drivers to some popular databases (currently PostgreSQL, ODBC, MySQL, SQLite, Oracle, and ADO; Interbase and Sybase are in our plans). LuaSQL defines a simple object-oriented API. All drivers should implement this common API, but each one is free to offer extensions.

LuaSQL defines one single global variable, a table called luasql. This table is used to store the initialization methods of the loaded drivers. These methods are used to create an objet d'environnement which is used to create a connection object. A connection object can execute SQL statements and eventually create a cursor object which is used to retrieve data.

LuaSQL is free software and uses the same licence as Lua 5.1.

Compilation

LuaSQL est distribué comme un ensemble de fichiers de code source en C : un duo de fichier entète et commun (luasql.h et luasql.c); et un fichier source pour chaque pilote. Chaque pilote doit être compilé avec le fichier luasql.c pour générer une bibliothèque. Cette bibliothèque peut être liée à l'application ou chargée dynamiquement. La fonction d'initialisation est luaopen_luasqldrivername et elle est compatible avec la fonction Lua de chargement de bibliothèque.

Installation

Depuis la version 2.3, tous les pilotes LuaSQL suivent le modèle de paquet de Lua 5.2. Tous les pilotes doivent être "installées" dans votre package.cpath dans un dossier appelé luasql.

Pour utiliser LuaSQL avec ADO, assurez-vous d'avoir installé LuaCOM 1.3 pour la version appropriée de Lua.

Gestion des erreurs

LuaSQL est juste une couche d'abstraction qui communique entre Lua et un système de base de données Par conséquent des erreurs peuvent se produire sur les deux niveaux, c'est à dire, à l'intérieur du client de base de données ou à l'intérieur du pilote LuaSQL

Les erreurs telles que des instructions SQL malformées, des noms de table inconnues, etc. sont appelées erreures de base de données et seront signalées par la fonction/méthode retournant nil suivie par le message d'erreur fourni par le système de base de données. Les erreurs telles que des paramètres erronés, des connexion manquantes, des objets invalides, etc. sont appelées erreures API, sont généralement des erreurs de programme et seront remontées par une erreur Lua.

Ce comportement sera suivi par toutes les fonctions/méthodes décrites dans le présent document, sauf indication contraire.

Pilotes

Un pilote LuaSQL permet l'utilisation de l'API LuaSQL avec un système de gestion de base de données qui correspond au pilote. Pour utiliser un pilote vous devez le charger. L'exemple ci-dessous

local driver = require "luasql.odbc"

charge le pilote ODBC et retourne une table avec une entrée avec le nom du pilote (odbc dans ce cas). Notez que vous pouvez avoir plus d'un pilote chargé en même temps en faisant quelque chose comme :

local odbc_driver = require "luasql.odbc"
local oci8_driver = require "luasql.oci8"

Cet exemple montre également que le nom du pilote ne correspond pas toujours au nom de la base de données, mais au nom du pilote dans le système de fichiers. Depuis qu'il se base sur l'API OCI8, le pilote Oracle a le nom oci8.

Objets d'environnement

Un objet d'environnement est créé en appelant la fonction d'initialisation du pilote qui est stocké dans le tableau retourné quand il a été chargé, indexé avec le même nom que le pilote (odbc, postgres etc). L'exemple suivant, va essayer de créer un objet d'environnement en utilisant le pilote ODBC.

local driver = require"luasql.odbc"
local env = driver.odbc()

Méthodes

env:close()

Ferme l'environnement env. Ne réussis que si toutes les connexions le concernant ont été préalablement fermées. Only successful if all connections pertaining to it were closed first.
Retourne : true en cas de succès; false quand l'objet est déjà fermé.

env:connect(sourcename[,username[,password]])

Se connecter a une source de données spécifiée dans sourcename en utilisant username et password s'ils sont fournis.
Le sourcename peut varier en fonction de chaque pilote.. Certains utilisent un nom de base de données simple, comme PostgreSQL, MySQL et SQLite; le pilote ODBC attend le nom du DSN; le pilote Oracle attend le nom du service; Voir aussi : les extentions PostgreSQL, et MySQL.
Retourne : un objet de connexion.

Objet de connection

A connection object contains specific attributes and parameters of a single data source connection. A connection object is created by calling the environment:connect method.

Méthodes

conn:close()

Closes the connection conn. Only successful if all cursors pertaining to it have been closed and the connection is still open.
Retourne : true in case of success and false in case of failure.

conn:commit()

Commits the current transaction. This feature might not work on database systems that do not implement transactions.
Retourne : 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.
Retourne : 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.
Retourne : 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.
Retourne : true in case of success and false when the operation could not be performed or when it is not implemented.

Objet de curseur

A cursor object contains methods to retrieve data resulting from an executed statement. A cursor object is created by using the connection:execute function. See also PostgreSQL and Oracle extensions.

Méthodes

cur:close()

Closes this cursor.
Retourne : 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 directly to the caller. If fetch is called with a table, the results will be copied into the table and the changed table will be returned. In this case, an optional modestring parameter can be used. It is just a string indicating how the resulting table should be constructed. 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.
A call to fetch after the last row has already being returned will close the corresponding cursor. There is no guarantee about the types of the results: they may or may not be converted to adequate Lua types by the driver. In the current implementation, the PostgreSQL and MySQL drivers return all values as strings while the ODBC and Oracle drivers convert them to Lua types.
Retourne : data, as above, or nil if there are no more rows. Note that this method could return nil as a valid result.

cur:getcolnames()

Retourne : a list (table) of column names.

cur:getcoltypes()

Retourne : a list (table) of column types.

Extensions PostgreSQL

Besides the basic functionality provided by all drivers, the Postgres driver also offers these extra features:

env:connect(sourcename[,username[,password[,hostname[,port]]]])

In the PostgreSQL driver, this method adds two 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>"))
Voir aussi : Objets d'environnement
Retourne : un objet de connexion

conn:escape(str)

Protège les caractères particuliers dans la chaîne de caractères en fonction du jeu de caractères (charset) de la connexion.
Voir aussi : La documentation officiel de la fonction PQescapeStringConn
Retourne : la chaîne protégée/échappée.

cur:numrows()

Voir aussi : cursor objects
Retourne : the number of rows in the query result.

Extensions MySQL

Besides the basic functionality provided by all drivers, the MySQL driver also offers these extra features:

env:connect(sourcename[,username[,password[,hostname[,port]]]])

In the MySQL driver, this method adds two optional parameters that indicate the hostname and port to connect.
Voir aussi : Objets d'environnement
Retourne : un objet de connexion

conn:escape(str)

Protège les caractères particuliers dans la chaîne de caractères en fonction du jeu de caractères (charset) de la connexion.
Voir aussi : La documentation officiel de la fonction mysql_real_escape_string
Retourne : la chaîne protégée/échappée.

conn:getlastautoid()

Obtains the value generated for an AUTO_INCREMENT column by the previous INSERT or UPDATE statement.
Voir aussi : Official documentation of function mysql_insert_id for versions 4.0, 5.1 and 6.0
Retourne : the number of the last value generated for an AUTO_INCREMENT column.

cur:numrows()

Voir aussi : cursor objects
Retourne : the number of rows in the query result.

Notes:

This driver is compatible with versions 4.0, 4.1 and 5.0 of the MySQL API. Only from version 4.1 MySQL provides support for transactions by using BDB or INNODB tables. Therefore, with version 4.0 or without one of these types of tables, the methods commit, rollback and setautocommit will not work.

If you are using LuaSQL 2.0, cur:numrows() is available only in version 2.0.2 or later.

Extensions Oracle

Besides the basic functionality provided by all drivers, the Oracle driver also offers this extra feature:

cur:numrows()

Voir aussi : cursor objects
Retourne : the number of rows in the query result.

Extensions SQLite3

Outre les fonctionnalités de base fournies par tous les pilotes, le pilote SQLite3 propose également ces fonctionnalités supplémentaires :

env:connect(sourcename[,locktimeout])

Dans le pilote SQLite3, cette méthode ajoute un paramètre facultatif qui indique la quantité en millisecondes à attendre pour un verrou en écriture, s'il ne peut être obtenu immédiatement.
Voir aussi : Objets d'environnement
Retourne : un objet de connexion

conn:escape(str)

Protège les caractères particuliers dans la chaîne de caractères en fonction du jeu de caractères (charset) de la connexion.
Voir aussi : La documentation officiel de la fonction sqlite3_mprintf
Retourne : la chaîne protégée/échappée.