r9402: Reworked docstrings.
[clsql.git] / doc / TODO
1 DOCUMENTATION TO DO LIST
2
3 1. Variances from CommonSQL
4
5  - Ideally, this will be extremely minimal
6
7  - The SQL syntax state functions are macros in CLSQL. 
8
9 2. Underdocumented CommonSQL features:
10
11  - Retrieval immediate
12  - SQL operators: ||, SUBSTR, MINUS, INTERSECT, UNION, NVL 
13
14 2. CLSQL extensions to CommonSQL
15
16  - RESULT-TYPES, FIELD-NAMES keywords for SELECT and QUERY
17
18  - New types such as wall-time, boolean, and bigint
19
20  - SQL operators: group-by, limit, not-null, ==, is, having, the, uplike,
21    sql-view-class, coalesce, except (just from a quick scan of 
22    operations.lisp)
23
24  - FDDL: list-views, view-exists-p, list-indexes, list-table-indexes,
25    index-exists-p, create-sequence, drop-sequence, list-sequences,
26    sequence-exists-p, sequence-next, sequence-last, set-sequence-position
27
28  - OODML: *db-auto-sync*
29
30  - SELECT: additional keyword arguments accepted include :LIMIT, :OFFSET, 
31    :INNER-JOIN and :ON. 
32
33  - SQL-RECORDING-P: also accepts :both and :either values for the TYPE 
34    parameter. 
35
36  - SQL-EXPRESSION: also accepts a :params keyword arg which is passed 
37
38 4. Documenting lower level, non-CommonSQL functions (some of this is already 
39    done). 
40
41  - connection pools
42  - database-query-result-set 
43
44 5. Notes on any peculiarities of each of the backends (e.g., unsupported 
45    features, notable extensions etc.). 
46
47  - MYSQL 
48
49    drop-index:   requires a table to be specified with the :from parameter
50    views:        mysql does not support views  
51    queries:      nested subqueries are not supported
52    syntax:       doesn't support the sql concatenation operator (||). 
53                  doesn't support INTERSECT/EXCEPT set operations. 
54
55  - SQLITE 
56
57    connection:   specifying ":memory:" gives you an SQLite database in RAM.
58    create-view:  column-list parameter not supported 
59    syntax:       doesn't support the sql SUBSTRING operator. 
60