Remove redundant file from freeradius-abfab list.
[freeradius.git] / src / modules / rlm_sql / README
1 FreeRADIUS SQL Module
2
3 The core rlm_sql code handles database indepenent stuff and links the specific database drivers depending on your config. Sample sql configurations can be found in the raddb/sql.conf file.
4
5
6 Mike Machado
7 mike@innercite.com
8 InnerCite Inc.
9 Engineering Director / CTO
10
11 Returning 'SQL_DOWN' allows sql.c to reconnect and try again, in most cases
12
13 sql_select_query: returns -1 on failure, SQL_DOWN on 'socket not connected'
14 sql_query: returns -1 on failure, SQL_DOWN on 'socket not connected'
15 sql_store_result: returns -1 on failure, SQL_DOWN on 'socket not connected'
16 sql_num_fields: cannot return an error, complains if zero fields
17 sql_finish_select_query: returns 0 always
18 sql_finish_query: does nothing, returns 0
19 sql_free_result: returns 0 always, mysql_free_result has no return value
20 sql_release_socket: returns 1 always
21 sql_fetch_row: returns 0 if ok, SQL_DOWN on 'socket not connected', row is
22                 in sqlsocket->row now
23
24 TODO:
25
26 db2/iodbc/unixodbc:
27      for the above functions, where it can return SQL_DOWN, determine if an
28      error with the database exists, if it is down, and return SQL_DOWN
29