Skip to content

Commit ced2cc1

Browse files
committed
Update README.md
1 parent 0bf82f2 commit ced2cc1

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ databases like so:
2929
`sqlitedb` variable holds the most recently created `SqliteDB` type and other
3030
Sqlite functions (i.e. `query`) will use it by default in the absence of a specified connection.
3131

32-
* `Sqlite.query(conn::SqliteDB=sqlitedb, querystring::String)`
32+
* `Sqlite.query(querystring::String,conn::SqliteDB=sqlitedb)`
3333

3434
If a connection type isn't specified as the first positional argument, the query will be executed against
3535
the default connection (stored in the exported variable `sqlitedb` if you'd like to
@@ -40,7 +40,7 @@ inspect).
4040

4141
For the general user, a simple `Sqlite.query(querystring)` is enough to return a single resultset in a DataFrame. Results are stored in the passed SqliteDB type's resultset field. (i.e. `sqlitedb.resultset`). Results are stored by default to avoid immediate garbarge collection and provide access for the user even if the resultset returned by query isn't stored in a variable.
4242

43-
* `createtable(conn::SqliteDB=sqlitedb,df::DataFrame;name::String="")`
43+
* `createtable(input::TableInput,conn::SqliteDB=sqlitedb;name::String="")`
4444

4545
`createtable` takes its `DataFrame` argument and converts it to an Sqlite table in the specified `SqliteDB`. By default, the resulting table will have the same name as the DataFrame variable, unless specifically passed with the `name` keyword argument.
4646

@@ -62,6 +62,8 @@ inspect).
6262
Stores information about an Sqlite database connection. Names include `file` for the Sqlite database filename, `handle` as the internal connection handle pointer, and `resultset` which
6363
stores the last resultset returned from a `Sqlite.query` call.
6464

65+
* `typealias TableInput Union(DataFrame,String)`
66+
6567
#### Variables
6668
* `sqlitedb`
6769
Global, exported variable that initially holds a null `SqliteDB` type until a connection is successfully made by `Sqlite.connect`. Is used by `query` as the default datasource `SqliteDB` if none is explicitly specified.

0 commit comments

Comments
 (0)