Difference between revisions of "Gambas/libraries/gb.db/Connection"

from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
< Gambas‎ | libraries‎ | gb.db
Jump to navigation Jump to search
m (→‎Navigation: navbar tweak)
(updating links to use subpages)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Navigation==
+
==About==
[[computing]]: [[software]]: [[programming]]: [[Gambas]]: [[gb.db]].'''Connection'''
+
The {{l/same|Connection}} class provides an interface to a particular [[database engine]] connection. It is similar to the Connection interface in [[ADO (Microsoft)|ADO]].
 
 
==Overview==
 
The [[gb.db.Connection]] class provides an interface to a particular [[database engine]] connection. It is similar to the Connection interface in [[ADO (Microsoft)|ADO]].
 
 
==Usage==
 
==Usage==
 
To connect to a database server: create a connection object, fill the needed properties, and call the Open method.
 
To connect to a database server: create a connection object, fill the needed properties, and call the Open method.
Line 25: Line 22:
 
|-
 
|-
 
| valign=top |
 
| valign=top |
* [[Charset (gb.db.Connection)|Charset]]() AS String [[read-only property|(r)]]
+
* {{l/sub|Charset}}() AS String [[read-only property|(r)]]
* [[Databases (gb.db.Connection)|Databases]] AS [[.ConnectionDatabases (gb.db)|.ConnectionDatabases]]
+
* {{l/sub|Databases}} AS {{l/same|.ConnectionDatabases}}
* [[Host (gb.db.Connection)|Host]] AS String
+
* {{l/sub|Host}} AS String
* [[Login (gb.db.Connection)|Login]] AS String
+
* {{l/sub|Login}} AS String
* [[Name (gb.db.Connection)|Name]] AS String
+
* {{l/sub|Name}} AS String
* [[Password (gb.db.Connection)|Password]] AS String
+
* {{l/sub|Password}} AS String
* [[Port (gb.db.Connection)|Port]] AS String
+
* {{l/sub|Port}} AS String
* [[Tables (gb.db.Connection)|Tables]] AS [[.ConnectionTables (gb.db)|.ConnectionTables]]
+
* {{l/sub|Tables}} AS {{l/same|.ConnectionTables}}
* [[Type (gb.db.Connection)|Type]] AS String
+
* {{l/sub|Type}} AS String
* [[Users (gb.db.Connection)|Users]] AS [[.ConnectionUsers (gb.db)|.ConnectionUsers]]
+
* {{l/sub|Users}} AS {{l/same|.ConnectionUsers}}
* [[Version (gb.db.Connection)|Version]] AS Integer [[read-only property|(r)]]
+
* {{l/sub|Version}} AS Integer [[read-only property|(r)]]
 
| valign=top |
 
| valign=top |
* [[Begin (gb.db.Connection)|Begin]]()
+
* {{l/sub|Begin}}()
* [[Close (gb.db.Connection)|Close]]()
+
* {{l/sub|Close}}()
* [[Commit (gb.db.Connection)|Commit]]()
+
* {{l/sub|Commit}}()
* [[Create (gb.db.Connection)|Create]]( <u>Table</u> AS String ) AS [[Result (gb.db)|Result]]
+
* {{l/sub|Create}}( <u>Table</u> AS String ) AS {{l/same|Result}}
* [[Edit (gb.db.Connection)|Edit]]( <u>Table</u> AS String {{optargs|, <u>Request</u> AS String, <u>Arguments</u> AS , ...}} ) AS [[Result (gb.db)|Result]]
+
* {{l/sub|Edit}}( <u>Table</u> AS String {{optargs|, <u>Request</u> AS String, <u>Arguments</u> AS , ...}} ) AS {{l/same|Result}}
* [[Exec (gb.db.Connection)|Exec]]( <u>Request</u> AS String, Arguments AS {{optargs|, ...}} ) AS [[Result (gb.db)|Result]]
+
* {{l/sub|Exec}}( <u>Request</u> AS String, Arguments AS {{optargs|, ...}} ) AS {{l/same|Result}}
* [[Find (gb.db.Connection)|Find]]( <u>Table</u> AS String {{optargs|, <u>Request</u> AS String, <u>Arguments</u> AS , ...}} ) AS [[Result (gb.db)|Result]]
+
* {{l/sub|Find}}( <u>Table</u> AS String {{optargs|, <u>Request</u> AS String, <u>Arguments</u> AS , ...}} ) AS {{l/same|Result}}
* [[Open (gb.db.Connection)|Open]]() AS Boolean
+
* {{l/sub|Open}}() AS Boolean
* [[Quote (gb.db.Connection)|Quote]]( <u>Name</u> AS String ) AS String  
+
* {{l/sub|Quote}}( <u>Name</u> AS String ) AS String  
* [[Rollback (gb.db.Connection)|Rollback]]()
+
* {{l/sub|Rollback}}()
 
|}
 
|}
 +
==Links==
 +
===Reference===
 +
* [http://gambasdoc.org/help/comp/gb.db/connection Gambas Documentation]

Latest revision as of 20:24, 24 April 2013

About

The Connection class provides an interface to a particular database engine connection. It is similar to the Connection interface in ADO.

Usage

To connect to a database server: create a connection object, fill the needed properties, and call the Open method.

For SQLite connections, the following algorithm is used:

  • If Name is null, then a memory database is opened.
  • If Name is an absolute path, then this path is used.
  • If Name is a relative path, then:
    • If Host is null, then the database is located in the application temporary directory, which is /tmp/gambas.$UID/sqlite .
    • Otherwise, Host gives the database directory, and the database path is the result of concatenating Host and Name.

This class is creatable:

DIM hConnection AS Connection
hConnection = NEW Connection ( ) 

Identifiers

Properties Methods
  1. REDIRECT Template:arg/opt ) AS Result
  • Exec( Request AS String, Arguments AS
  1. REDIRECT Template:fmt/arg/opt ) AS Result
  • Find( Table AS String [ <, Request AS String, Arguments AS , ...> ] ) AS Result
  • Open() AS Boolean
  • Quote( Name AS String ) AS String
  • Rollback()

Links

Reference