r9722: Document the FDML.
[clsql.git] / doc / TODO
1 DOCUMENTATION TO DO LIST
2
3 1. Variances from CommonSQL (Ideally, this will be extremely minimal) 
4
5  - The SQL syntax state functions are macros in CLSQL. 
6
7  - CLSQL starts with in transaction AUTOCOMMIT mode. To begin a transaction,
8    START-TRANSACTION has to be called.
9
10
11 2. Underdocumented CommonSQL features:
12
13  - Retrieval immediate
14  - SQL operators: ||, SUBSTR, MINUS, INTERSECT, UNION, NVL 
15
16
17 3. CLSQL extensions to CommonSQL
18
19  - New types such as wall-time, boolean, and bigint
20
21  - SQL operators: group-by, limit, not-null, ==, is, having, the, uplike,
22    sql-view-class, coalesce, except (just from a quick scan of 
23    operations.lisp)
24
25  - FDML: FOR-EACH-ROW, prepared statements and large object support. 
26
27  - OODML: *db-auto-sync*
28
29  - SELECT: additional keyword arguments accepted include :LIMIT, :OFFSET, 
30    :INNER-JOIN and :ON. 
31
32  - SQL-RECORDING-P: also accepts :both and :either values for the TYPE 
33    parameter. 
34
35  - DEF-VIEW-CLASS: DB-CONSTRAINTS, DB-TYPE and VOID-VALUE slot options. 
36
37  - transactions: START-TRANSACTION and IN-TRANSACTION-P. 
38
39  - Tranactions: AUTOCOMMIT
40
41
42 4. Documenting lower level, non-CommonSQL functions (some of this is already 
43    done). 
44
45  - connection pools
46  - database-query-result-set 
47  
48
49 5. Notes on any peculiarities of each of the backends (e.g., unsupported 
50    features, notable extensions etc.). 
51
52  - MYSQL 
53
54    drop-index:   requires a table to be specified with the :on parameter
55    views:        mysql does not support views  
56    queries:      nested subqueries are not supported
57    syntax:       doesn't support the sql concatenation operator (||). 
58                  doesn't support INTERSECT/EXCEPT set operations. 
59    create-table: the transactions keyword arg controls whether the created 
60                  table is an InnoDB table (supporting transactions) or not. 
61    FDDL:         list-*/*-exists-p: :OWNER keyword argument ignored. 
62
63  - SQLITE 
64
65    connection:   specifying ":memory:" gives you an SQLite database in RAM.
66    create-view:  column-list parameter not supported 
67    syntax:       doesn't support the sql SUBSTRING operator. 
68    FDDL:         list-*/*-exists-p: :OWNER keyword argument ignored. 
69
70  - ODBC 
71
72    FDDL:         list-*/*-exists-p: :OWNER keyword argument ignored.