Skip to content

Commit 8c320c2

Browse files
committed
Update README.md
1 parent 2675d4c commit 8c320c2

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ julia> using SQLite # Loads the SQLite module for use (needs to be run wi
1212
## Package Documentation
1313

1414
#### Functions
15-
* `connect(file::String)`
15+
* `SQLite.connect(file::String)`
1616

17-
`connect` requires the `file` string argument as the name of either a pre-defined SQLite database to be opened, or if the database doesn't exist, one will be created.
17+
`SQLite.connect` requires the `file` string argument as the name of either a pre-defined SQLite database to be opened, or if the database doesn't exist, one will be created.
1818

19-
`connect` returns a `SQLiteDB` type which contains basic information
19+
`SQLite.connect` returns a `SQLiteDB` type which contains basic information
2020
about the connection and SQLite handle pointers.
2121

22-
`connect` can be used by storing the `Connection` type in
22+
`SQLite.connect` can be used by storing the `Connection` type in
2323
a variable to be able to close or facilitate handling multiple
2424
databases like so:
2525
```julia
26-
co = connect("mydatasource")
26+
co = SQLite.connect("mydatasource")
2727
```
2828
But it's unneccesary to store the `SQLiteDB`, as an exported
2929
`sqlitedb` variable holds the most recently created `SQLiteDB` type and other
@@ -68,13 +68,13 @@ stores the last resultset returned from a `query` call.
6868

6969
#### Variables
7070
* `sqlitedb`
71-
Global, exported variable that initially holds a null `SQLiteDB` type until a connection is successfully made by `connect`. Is used by `query` as the default datasource `SQLiteDB` if none is explicitly specified.
71+
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.
7272

7373
### Known Issues
7474
* We've had limited SQLite testing between various platforms, so it may happen that `SQLite.jl` doesn't recognize your SQLite shared library. The current approach, since SQLite doesn't come standard on many platforms, is to provide the shared library in the `SQLite.jl/lib` folder. If this doesn't work on your machine, you'll need to manually locate your SQLite shared library (searching for something along the lines of
7575
`libsqlite3` or `sqlite3`, or compiling/installing it yourself) and then run the following:
7676
```julia
77-
const sqlite3_lib = "path/to/library/sqlite3.so" (or .dylib on OSX)
77+
const SQLite.sqlite3_lib = "path/to/library/sqlite3.so" (or .dylib on OSX)
7878
```
7979

8080
That said, if you end up doing this, open an issue on GitHub to let me know if the library is on your platform by default and I can add it is as one of the defaults to check for.

0 commit comments

Comments
 (0)