From 4664111ce40b8e9fe41b3a34766ff6e476b41983 Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Fri, 9 Nov 2012 15:01:41 -0500 Subject: [PATCH] Update docs and readme --- README.md | 22 ++++++++++++++++++++++ docs/classes/BadConnectionException.html | 2 +- docs/classes/BadDBDriverException.html | 2 +- docs/classes/DB_PDO.html | 2 +- docs/classes/DB_SQL.html | 2 +- docs/classes/DB_Util.html | 2 +- docs/classes/Firebird.html | 2 +- docs/classes/Firebird_Result.html | 2 +- docs/classes/Firebird_SQL.html | 2 +- docs/classes/Firebird_Util.html | 2 +- docs/classes/MySQL.html | 2 +- docs/classes/MySQL_SQL.html | 2 +- docs/classes/MySQL_Util.html | 2 +- docs/classes/ODBC.html | 2 +- docs/classes/ODBC_SQL.html | 2 +- docs/classes/ODBC_Util.html | 2 +- docs/classes/PgSQL.html | 2 +- docs/classes/PgSQL_SQL.html | 2 +- docs/classes/PgSQL_Util.html | 2 +- docs/classes/Query_Builder.html | 2 +- docs/classes/Query_Parser.html | 2 +- docs/classes/SQLite.html | 2 +- docs/classes/SQLite_SQL.html | 2 +- docs/classes/SQLite_Util.html | 2 +- docs/deprecated.html | 2 +- docs/errors.html | 2 +- docs/graph_class.html | 2 +- docs/markers.html | 2 +- docs/namespaces/default.html | 2 +- docs/packages/.html | 2 +- docs/packages/Default.html | 2 +- docs/packages/Query.Drivers.html | 2 +- docs/packages/Query.Query.html | 2 +- docs/packages/Query.html | 2 +- docs/structure.xml | 14 +++++++------- 35 files changed, 62 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 304b6d4..fc94459 100644 --- a/README.md +++ b/README.md @@ -38,11 +38,33 @@ Create a connection array or object similar to this: // Only required // SQLite or Firebird 'file' => '/path/to/db/file', + + // Optional paramaters + 'prefix' => 'tbl_', // Database table prefix + 'alias' => 'old' // Connection name for the Query function ); $db = Query($params); The parameters required depend on the database. + +### Query function + +You can use the `Query()` function as a reference to the last connected database. E.g. + + Query()->get('table_name'); + +or + + $result = Query()->query($sql); + +If the `alias` key is set in the parameters, you can refer to a specific database connection + + // Set the alias in the connection parameters + $params['alias'] = 'old'; + + // Connect to the legacy database + Query('old')->query($sql); ### Running Queries Query uses the same interface as CodeIgniter's [Active Record class](http://codeigniter.com/user_guide/database/active_record.html). However, it does not implement the `insert_batch`, `update_batch` or caching methods. diff --git a/docs/classes/BadConnectionException.html b/docs/classes/BadConnectionException.html index 81d2089..1852489 100644 --- a/docs/classes/BadConnectionException.html +++ b/docs/classes/BadConnectionException.html @@ -219,7 +219,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/BadDBDriverException.html b/docs/classes/BadDBDriverException.html index db45325..fcef3f8 100644 --- a/docs/classes/BadDBDriverException.html +++ b/docs/classes/BadDBDriverException.html @@ -219,7 +219,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/DB_PDO.html b/docs/classes/DB_PDO.html index 35ecb27..f8a218d 100644 --- a/docs/classes/DB_PDO.html +++ b/docs/classes/DB_PDO.html @@ -757,7 +757,7 @@ the connection/database
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/DB_SQL.html b/docs/classes/DB_SQL.html index 57fca8f..23465d8 100644 --- a/docs/classes/DB_SQL.html +++ b/docs/classes/DB_SQL.html @@ -244,7 +244,7 @@ specified table
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/DB_Util.html b/docs/classes/DB_Util.html index 1bd681e..b4de4fa 100644 --- a/docs/classes/DB_Util.html +++ b/docs/classes/DB_Util.html @@ -210,7 +210,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/Firebird.html b/docs/classes/Firebird.html index 846329d..76ecd60 100644 --- a/docs/classes/Firebird.html +++ b/docs/classes/Firebird.html @@ -941,7 +941,7 @@ the last query executed
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/Firebird_Result.html b/docs/classes/Firebird_Result.html index f7dfab0..9533155 100644 --- a/docs/classes/Firebird_Result.html +++ b/docs/classes/Firebird_Result.html @@ -505,7 +505,7 @@ the query
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/Firebird_SQL.html b/docs/classes/Firebird_SQL.html index 295ee2d..9dabb1d 100644 --- a/docs/classes/Firebird_SQL.html +++ b/docs/classes/Firebird_SQL.html @@ -234,7 +234,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/Firebird_Util.html b/docs/classes/Firebird_Util.html index 9d3ae8d..6313f07 100644 --- a/docs/classes/Firebird_Util.html +++ b/docs/classes/Firebird_Util.html @@ -213,7 +213,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/MySQL.html b/docs/classes/MySQL.html index b8832ac..27e15f3 100644 --- a/docs/classes/MySQL.html +++ b/docs/classes/MySQL.html @@ -977,7 +977,7 @@ the connection/database
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/MySQL_SQL.html b/docs/classes/MySQL_SQL.html index 899610c..7beee03 100644 --- a/docs/classes/MySQL_SQL.html +++ b/docs/classes/MySQL_SQL.html @@ -239,7 +239,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/MySQL_Util.html b/docs/classes/MySQL_Util.html index 8d5d9bc..673fc45 100644 --- a/docs/classes/MySQL_Util.html +++ b/docs/classes/MySQL_Util.html @@ -209,7 +209,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/ODBC.html b/docs/classes/ODBC.html index 769b554..bdb7dcc 100644 --- a/docs/classes/ODBC.html +++ b/docs/classes/ODBC.html @@ -979,7 +979,7 @@ the connection/database
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/ODBC_SQL.html b/docs/classes/ODBC_SQL.html index ed819cf..a92e98e 100644 --- a/docs/classes/ODBC_SQL.html +++ b/docs/classes/ODBC_SQL.html @@ -234,7 +234,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/ODBC_Util.html b/docs/classes/ODBC_Util.html index e3537a8..cdedbb8 100644 --- a/docs/classes/ODBC_Util.html +++ b/docs/classes/ODBC_Util.html @@ -204,7 +204,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/PgSQL.html b/docs/classes/PgSQL.html index 381788a..ee9c249 100644 --- a/docs/classes/PgSQL.html +++ b/docs/classes/PgSQL.html @@ -979,7 +979,7 @@ the connection/database
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/PgSQL_SQL.html b/docs/classes/PgSQL_SQL.html index 66bc56d..7ef7e8a 100644 --- a/docs/classes/PgSQL_SQL.html +++ b/docs/classes/PgSQL_SQL.html @@ -234,7 +234,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/PgSQL_Util.html b/docs/classes/PgSQL_Util.html index bf0ff97..173c8ac 100644 --- a/docs/classes/PgSQL_Util.html +++ b/docs/classes/PgSQL_Util.html @@ -209,7 +209,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/Query_Builder.html b/docs/classes/Query_Builder.html index 190bbf4..ba77857 100644 --- a/docs/classes/Query_Builder.html +++ b/docs/classes/Query_Builder.html @@ -1361,7 +1361,7 @@ passed array with key / value pairs
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/Query_Parser.html b/docs/classes/Query_Parser.html index b3cf082..49ab5ae 100644 --- a/docs/classes/Query_Parser.html +++ b/docs/classes/Query_Parser.html @@ -145,7 +145,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/SQLite.html b/docs/classes/SQLite.html index 3a66b28..4f30c91 100644 --- a/docs/classes/SQLite.html +++ b/docs/classes/SQLite.html @@ -994,7 +994,7 @@ method if the database does not support 'TRUNCATE';
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/SQLite_SQL.html b/docs/classes/SQLite_SQL.html index ea7b171..aaf5207 100644 --- a/docs/classes/SQLite_SQL.html +++ b/docs/classes/SQLite_SQL.html @@ -234,7 +234,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/classes/SQLite_Util.html b/docs/classes/SQLite_Util.html index dffba02..e546bb4 100644 --- a/docs/classes/SQLite_Util.html +++ b/docs/classes/SQLite_Util.html @@ -209,7 +209,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/deprecated.html b/docs/deprecated.html index 81b0319..e85fbec 100644 --- a/docs/deprecated.html +++ b/docs/deprecated.html @@ -68,7 +68,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/errors.html b/docs/errors.html index c6d00c2..7544970 100644 --- a/docs/errors.html +++ b/docs/errors.html @@ -236,7 +236,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/graph_class.html b/docs/graph_class.html index 282a7d5..53f7905 100644 --- a/docs/graph_class.html +++ b/docs/graph_class.html @@ -65,7 +65,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/markers.html b/docs/markers.html index 22ff582..2004e14 100644 --- a/docs/markers.html +++ b/docs/markers.html @@ -146,7 +146,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html index da726da..9adbc4b 100644 --- a/docs/namespaces/default.html +++ b/docs/namespaces/default.html @@ -333,7 +333,7 @@ instantiates the specific db driver

+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/packages/.html b/docs/packages/.html index 9fe106c..3713c01 100644 --- a/docs/packages/.html +++ b/docs/packages/.html @@ -68,7 +68,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/packages/Default.html b/docs/packages/Default.html index b1f0af0..bcada64 100644 --- a/docs/packages/Default.html +++ b/docs/packages/Default.html @@ -95,7 +95,7 @@
+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/packages/Query.Drivers.html b/docs/packages/Query.Drivers.html index 5dff6ad..8d2790e 100644 --- a/docs/packages/Query.Drivers.html +++ b/docs/packages/Query.Drivers.html @@ -212,7 +212,7 @@ data-fetching methods

+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/packages/Query.Query.html b/docs/packages/Query.Query.html index bdbcf8c..13ac96d 100644 --- a/docs/packages/Query.Query.html +++ b/docs/packages/Query.Query.html @@ -140,7 +140,7 @@ instantiates the specific db driver

+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/packages/Query.html b/docs/packages/Query.html index 36ed318..72dd87b 100644 --- a/docs/packages/Query.html +++ b/docs/packages/Query.html @@ -355,7 +355,7 @@ instantiates the specific db driver

+ generated on 2012-11-09T15:01:27-05:00.
diff --git a/docs/structure.xml b/docs/structure.xml index 12da826..d04684f 100644 --- a/docs/structure.xml +++ b/docs/structure.xml @@ -2469,7 +2469,7 @@ in place of the get() method]]> - + Free Query Builder / Database Abstraction Layer

]]> @@ -2543,22 +2543,22 @@ with array_map and glob]]> - + Query function - + - + mixed - + \Query_Builder - + $params - +