You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,18 +12,18 @@ julia> using SQLite # Loads the SQLite module for use (needs to be run wi
12
12
## Package Documentation
13
13
14
14
#### Functions
15
-
*`connect(file::String)`
15
+
*`SQLite.connect(file::String)`
16
16
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.
18
18
19
-
`connect` returns a `SQLiteDB` type which contains basic information
19
+
`SQLite.connect` returns a `SQLiteDB` type which contains basic information
20
20
about the connection and SQLite handle pointers.
21
21
22
-
`connect` can be used by storing the `Connection` type in
22
+
`SQLite.connect` can be used by storing the `Connection` type in
23
23
a variable to be able to close or facilitate handling multiple
24
24
databases like so:
25
25
```julia
26
-
co =connect("mydatasource")
26
+
co =SQLite.connect("mydatasource")
27
27
```
28
28
But it's unneccesary to store the `SQLiteDB`, as an exported
29
29
`sqlitedb` variable holds the most recently created `SQLiteDB` type and other
@@ -68,13 +68,13 @@ stores the last resultset returned from a `query` call.
68
68
69
69
#### Variables
70
70
*`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.
72
72
73
73
### Known Issues
74
74
* 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
75
75
`libsqlite3` or `sqlite3`, or compiling/installing it yourself) and then run the following:
76
76
```julia
77
-
const sqlite3_lib ="path/to/library/sqlite3.so" (or .dylib on OSX)
77
+
constSQLite.sqlite3_lib ="path/to/library/sqlite3.so" (or .dylib on OSX)
78
78
```
79
79
80
80
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