Skip to content

Commit 5e043eb

Browse files
committed
update function docs
1 parent 2eacdb8 commit 5e043eb

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

inst/@octave_sqlite/fetch.m

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
## -*- texinfo -*-
2020
## @deftypefn {} {@var{data} =} fetch (@var{db}, @var{sqlquery})
21+
## @deftypefnx {} {@var{data} =} fetch (@var{db}, @var{sqlquery}, @var{propertyname}, @var{propertyvalue} @dots{})
2122
## Return rows of data after runnning a sql query on a sqlite database.
2223
##
2324
## @subsubheading Inputs

inst/sqlite.m

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,20 @@
3333
## a opened SQLITE database as a octave_sqlite object
3434
## @end table
3535
##
36+
## @subsubheading Object Properties
37+
## The octave_sqlite object has the following properties:
38+
##
39+
## @table @asis
40+
## @item Database
41+
## The name of the opened database file (readonly)
42+
## @item IsOpen
43+
## Boolean field for if the database is currently open (readonly)
44+
## @item IsReadOnly
45+
## Boolean field for if the database was opened in readonly mode. (readonly)
46+
## @item AutoCommit
47+
## String flag field for whether database is in auto commit mode. "on" (default) or "off".
48+
## @end table
49+
##
3650
## @subsubheading Examples
3751
## Open a sqlite database, failing if it doesnt exist.
3852
## @example
@@ -41,7 +55,7 @@
4155
## }
4256
## @end example
4357
##
44-
## Open a sqlite database, creating it if it doesnt exist.
58+
## Open a sqlite database, creating it if it does not exist.
4559
## @example
4660
## @code {
4761
## db = sqlite("mytest.db", "create");

0 commit comments

Comments
 (0)