summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorJamie Matthews <[email protected]>2011-01-30 20:52:31 +0000
committerJamie Matthews <[email protected]>2011-01-30 20:52:31 +0000
commitc956f1c8250cfb07c29f5b14a43e2ca30747e2d6 (patch)
tree9c5af8c196321d5e8ae6cd8b9cf89b1acb82ccfa /README.markdown
parentd06ff35527d03e6d64a2184f6beb46e3d4eada03 (diff)
parentc5c67a38552b8773767157b4204fae6343afe168 (diff)
Merge branch 'develop'
* develop: Update changelog Issue #12: Fix incorrect quoting of column wildcard. Thanks pewterfish. Add MySQL-specific connection example in README Fix out-of-date comment and typo in README
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.markdown b/README.markdown
index 30ed852..2e6e6b5 100644
--- a/README.markdown
+++ b/README.markdown
@@ -36,6 +36,11 @@ Changelog
* Add `distinct` method
* Add `group_by` method
+#### 1.1.1 - release 2011-01-30
+
+* Fix bug in quoting column wildcard. j4mie/paris#12
+* Small documentation improvements
+
Philosophy
----------
@@ -58,10 +63,17 @@ First, `require` the Idiorm source file:
require_once 'idiorm.php';
-Then, pass a *Data Source Name* connection string to the `configure` method of the ORM class. This is used by PDO to connect to your database. For more information, see the [PDO documentation](http://uk2.php.net/manual/en/pdo.construct.php). Particularly, if you need to pass a username and password to your database driver, use the `username` and `password` configuration options. See "Configuration" section below.
-
+Then, pass a *Data Source Name* connection string to the `configure` method of the ORM class. This is used by PDO to connect to your database. For more information, see the [PDO documentation](http://uk2.php.net/manual/en/pdo.construct.php).
ORM::configure('sqlite:./example.db');
+You may also need to pass a username and password to your database driver, using the `username` and `password` configuration options. For example, if you are using MySQL:
+
+ ORM::configure('mysql:host=localhost;dbname=my_database');
+ ORM::configure('username', 'database_user');
+ ORM::configure('password', 'top_secret');
+
+Also see "Configuration" section below.
+
### Querying ###
Idiorm provides a [*fluent interface*](http://en.wikipedia.org/wiki/Fluent_interface) to enable simple queries to be built without writing a single character of SQL. If you've used [jQuery](http://jquery.com) at all, you'll be familiar with the concept of a fluent interface. It just means that you can *chain* method calls together, one after another. This can make your code more readable, as the method calls strung together in order can start to look a bit like a sentence.
@@ -116,7 +128,7 @@ Only a subset of the available conditions supported by SQL are available when us
These limits are deliberate: these are by far the most commonly used criteria, and by avoiding support for very complex queries, the Idiorm codebase can remain small and simple.
-Some support for more complex conditions and queries is provided by the `where_raw` and `raw_select` methods (see below). If you find yourself regularly requiring more functionality than Idiorm can provide, it may be time to consider using a more full-featured ORM.
+Some support for more complex conditions and queries is provided by the `where_raw` and `raw_query` methods (see below). If you find yourself regularly requiring more functionality than Idiorm can provide, it may be time to consider using a more full-featured ORM.
##### Equality: `where`, `where_equal`, `where_not_equal` #####