File: sqlite.hlp

package info (click to toggle)
slsqlite 0.4.0-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 88 kB
  • ctags: 88
  • sloc: ansic: 829; makefile: 39
file content (136 lines) | stat: -rw-r--r-- 3,837 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
sqlite_open

 SYNOPSIS
  Open a SQLite database

 USAGE
  Sqlite_Type sqlite_open(String_Type filename)

 DESCRIPTION
  Open the sqlite database file `filename'.  If the database file does
  not exist, then a new database will be created as needed.  On failure a
  `SqliteError' exception is thrown.

 SEE ALSO
  sqlite_get_table, sqlite_get_array, sqlite_get_row, sqlite_exec, sqlite_changes

--------------------------------------------------------------

sqlite_get_table

 SYNOPSIS
  Get a table of results from a SQLite query

 USAGE
  String_Type[] sqlite_get_table(Sqlite_Type db, String_Type query)

 DESCRIPTION
  This executes a query and returns the result as a 2d array of strings.
  The first row of the array contains the column headers.  This function does
  not support placeholders.

 NOTES
  You should only use this function if you need the column headers.
  Otherwise, use `sqlite_get_table'

 SEE ALSO
  sqlite_open, sqlite_get_row, sqlite_exec, sqlite_changes

--------------------------------------------------------------

sqlite_get_row

 SYNOPSIS
  Get a row of results from a SQLite query

 USAGE
  sqlite_get_row(Sqlite_Type db, String_Type query, ...)

 DESCRIPTION
  This executes a query and pushes the elements of the first row of the
  result on the stack.  This supports string, integer, float and blob
  datatatypes. Blobs are returned as bstrings.  If there are no rows, a
  `SqliteError' exception is thrown even if the query executed flawlessly.
  Question marks in the query are placeholders.  Extra arguments to the
  function are bound to these placeholders from left to right.

 EXAMPLE

   (foo, bar) = sqlite_get_row("SELECT foo, bar FROM table WHERE baz = ?", "quux");


 NOTES
  To get the result of a query that returns multiple rows, use
  `sqlite_get_array' or use

  foreach foo, bar (db) using ("SELECT foo, bar FROM table WHERE baz = ?", "quux")
  {
      ....
  }


 SEE ALSO
  sqlite_open, sqlite_get_table, sqlite_exec, sqlite_changes

--------------------------------------------------------------

sqlite_get_array

 SYNOPSIS
  Get a 2-D array from a SQLite query

 USAGE
  Array_Type sqlite_get_array(Sqlite_Type db, DataType_type type, String_Type query, ...)

 DESCRIPTION
  Executes a query and returns the result as a 2d array of type `type'.
  This supports string, integer, float and blob datatatypes. Question marks
  in the query are placeholders. Extra arguments to the function are bound
  to these placeholders from left to right.

 SEE ALSO
  sqlite_open, sqlite_get_table, sqlite_get_array, sqlite_get_row, sqlite_exec, sqlite_changes

--------------------------------------------------------------

sqlite_exec

 SYNOPSIS
  Execute a SQLite query

 USAGE
  sqlite_exec(Sqlite_Type db, String_Type query, ...)

 DESCRIPTION
  Execute a SQL query on a sqlite database, without returning a result.
  Question marks in the query are placeholders.  Extra arguments to the
  function are bound to these placeholders from left to right.

 EXAMPLE

  sqlite_exec("INSERT INTO table(foo,bar,baz) VALUES (?,?,?)", 1, 2, 3);


 SEE ALSO
  sqlite_open, sqlite_get_table, sqlite_get_array, sqlite_get_row, sqlite_changes

--------------------------------------------------------------

sqlite_changes

 SYNOPSIS
  Get the number of rows affected by a SQLite query

 USAGE
  Int_Type sqlite_changes(Sqlite_Type db)

 DESCRIPTION
  This function returns the number of database rows that were changed (or
  inserted or deleted) by the most recently completed INSERT, UPDATE, or
  DELETE statement.  The change count for "DELETE FROM table" will be zero
  regardless of the number of elements that were originally in the table.

 SEE ALSO
  sqlite_open, sqlite_get_table, sqlite_get_array, sqlite_get_row, sqlite_exec

--------------------------------------------------------------