Permalink
Browse files

Explaining database/dataset distinction

It is not obvious that the dataset name is to be used in URLs, and not the database name. I've added a note to that effect as a first effort at making that more clear.
  • Loading branch information...
1 parent f51be38 commit 39ec56edec7a69ea9089bf99644706b174ca4953 @waldoj waldoj committed Jan 4, 2013
Showing with 2 additions and 0 deletions.
  1. +2 −0 readme.md
View
@@ -105,6 +105,8 @@ register_db_api( 'facility-inspections', $args );
```
+Retrieving the contents of the table `history` within this dataset as JSON would be accomplished with a request for `/facility-inspections/history.json`. Note that it is the name of the dataset (`facility-inspections`) and not the name of the database (`inspections`) that is specified in the URL.
+
For a SQLite database, simply provide the path to the database in `name`.
For an Oracle database, you can either specify a service defined in tsnames.ora (e.g. `dept_spending`) or you can define an Oracle Instant Client connection string (e.g., `//localhost:1521/dept_spending`).

0 comments on commit 39ec56e

Please sign in to comment.