| libpreludedb Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | ||||
typedef preludedb_t;
typedef preludedb_result_idents_t;
typedef preludedb_result_values_t;
enum preludedb_result_idents_order_t;
#define PRELUDEDB_ERRBUF_SIZE
int preludedb_init (void);
void preludedb_deinit (void);
int preludedb_new (preludedb_t **db,
preludedb_sql_t *sql,
const char *format_name,
char *errbuf,
size_t size);
void preludedb_destroy (preludedb_t *db);
const char * preludedb_get_format_name (preludedb_t *db);
const char * preludedb_get_format_version (preludedb_t *db);
int preludedb_set_format (preludedb_t *db,
const char *format_name);
preludedb_sql_t * preludedb_get_sql (preludedb_t *db);
void preludedb_result_idents_destroy (preludedb_result_idents_t *result);
void preludedb_result_values_destroy (preludedb_result_values_t *result);
char * preludedb_get_error (preludedb_t *db,
preludedb_error_t error,
char *errbuf);
int preludedb_get_alert_idents (preludedb_t *db,
idmef_criteria_t *criteria,
int limit,
int offset,
preludedb_result_idents_order_t order,
preludedb_result_idents_t **result);
int preludedb_get_heartbeat_idents (preludedb_t *db,
idmef_criteria_t *criteria,
int limit,
int offset,
preludedb_result_idents_order_t order,
preludedb_result_idents_t **result);
int preludedb_get_alert (preludedb_t *db,
uint64_t ident,
idmef_message_t **message);
int preludedb_get_heartbeat (preludedb_t *db,
uint64_t ident,
idmef_message_t **message);
int preludedb_delete_alert (preludedb_t *db,
uint64_t ident);
int preludedb_delete_heartbeat (preludedb_t *db,
uint64_t ident);
ssize_t preludedb_delete_alert_from_list (preludedb_t *db,
uint64_t *idents,
size_t isize);
ssize_t preludedb_delete_alert_from_result_idents
(preludedb_t *db,
preludedb_result_idents_t *result);
ssize_t preludedb_delete_heartbeat_from_list
(preludedb_t *db,
uint64_t *idents,
size_t isize);
ssize_t preludedb_delete_heartbeat_from_result_idents
(preludedb_t *db,
preludedb_result_idents_t *result);
int preludedb_get_values (preludedb_t *db,
preludedb_path_selection_t *path_selection,
idmef_criteria_t *criteria,
prelude_bool_t distinct,
int limit,
int offset,
preludedb_result_values_t **result);
int preludedb_transaction_abort (preludedb_t *db);
int preludedb_transaction_end (preludedb_t *db);
int preludedb_transaction_start (preludedb_t *db);
typedef enum {
PRELUDEDB_RESULT_IDENTS_ORDER_BY_NONE = 0,
PRELUDEDB_RESULT_IDENTS_ORDER_BY_CREATE_TIME_DESC = 1,
PRELUDEDB_RESULT_IDENTS_ORDER_BY_CREATE_TIME_ASC = 2
} preludedb_result_idents_order_t;
int preludedb_new (preludedb_t **db,
preludedb_sql_t *sql,
const char *format_name,
char *errbuf,
size_t size);
This function initialize the db object and detect the format of the underlying database if no format name
is given.
|
Pointer to a db object to initialize. |
|
Pointer to a sql object. |
|
Format name of the underlying database, if NULL the format will be automatically detected |
|
Buffer that will be set to an error message if an error occur. |
|
size of errbuf.
|
Returns : |
0 on success or a negative value if an error occur. |
void preludedb_destroy (preludedb_t *db);
Destroy db object and the underlying sql object given as argument to preludedb_new.
|
Pointer to a db object. |
const char * preludedb_get_format_name (preludedb_t *db);
|
Pointer to a db object. |
Returns : |
the format name currently used by the db object.
|
const char * preludedb_get_format_version (preludedb_t *db);
|
Pointer to a db object. |
Returns : |
the format version currently used by the db object.
|
int preludedb_set_format (preludedb_t *db,
const char *format_name);
Change the current format plugin.
|
Pointer to a db object. |
|
New format to use. |
Returns : |
0 on success or negative value if an error occur. |
preludedb_sql_t * preludedb_get_sql (preludedb_t *db);
|
Pointer to a db object. |
Returns : |
a pointer to the underlying sql object. |
void preludedb_result_idents_destroy (preludedb_result_idents_t *result);
Destroy the result object.
|
Pointer to an idents result object. |
void preludedb_result_values_destroy (preludedb_result_values_t *result);
Destroy the result object.
|
Pointer to a result values object. |
char * preludedb_get_error (preludedb_t *db,
preludedb_error_t error,
char *errbuf);
Build an error message from the error code given as argument and from the sql plugin error string (if any) if the error code is db related.
FIXME: deprecated.
|
Pointer to a db object. |
|
Error code to build the error string from. |
|
Buffer where the error message will be stored, |
Returns : |
a pointer to the error string or NULL if an error occured. |
int preludedb_get_alert_idents (preludedb_t *db,
idmef_criteria_t *criteria,
int limit,
int offset,
preludedb_result_idents_order_t order,
preludedb_result_idents_t **result);
|
Pointer to a db object. |
|
Pointer to an idmef criteria. |
|
Limit of results or -1 if no limit. |
|
Offset in results or -1 if no offset. |
|
Result order. |
|
Idents result. |
Returns : |
the number of result or a negative value if an error occured. |
int preludedb_get_heartbeat_idents (preludedb_t *db,
idmef_criteria_t *criteria,
int limit,
int offset,
preludedb_result_idents_order_t order,
preludedb_result_idents_t **result);
|
Pointer to a db object. |
|
Pointer to an idmef criteria. |
|
Limit of results or -1 if no limit. |
|
Offset in results or -1 if no offset. |
|
Result order. |
|
Idents result. |
Returns : |
the number of result or a negative value if an error occured. |
int preludedb_get_alert (preludedb_t *db,
uint64_t ident,
idmef_message_t **message);
|
Pointer to a db object. |
|
Internal database ident of the alert. |
|
Pointer to an idmef message object where the retrieved message will be stored. |
Returns : |
0 on success or a negative value if an error occur. |
int preludedb_get_heartbeat (preludedb_t *db,
uint64_t ident,
idmef_message_t **message);
|
Pointer to a db object. |
|
Internal database ident of the heartbeat. |
|
Pointer to an idmef message object where the retrieved message will be stored. |
Returns : |
0 on success or a negative value if an error occur. |
int preludedb_delete_alert (preludedb_t *db,
uint64_t ident);
Delete an alert.
|
Pointer to a db object. |
|
Internal database ident of the alert. |
Returns : |
0 on success, or a negative value if an error occur. |
int preludedb_delete_heartbeat (preludedb_t *db,
uint64_t ident);
Delete an heartbeat.
|
Pointer to a db object. |
|
Internal database ident of the heartbeat. |
Returns : |
0 on success, or a negative value if an error occur. |
ssize_t preludedb_delete_alert_from_list (preludedb_t *db,
uint64_t *idents,
size_t isize);
Delete all alerts from ident stored within idents.
|
Pointer to a db object. |
|
Pointer to an array of idents. |
|
|
Returns : |
the number of alert deleted on success, or a negative value if an error occur. |
ssize_t preludedb_delete_alert_from_result_idents
(preludedb_t *db,
preludedb_result_idents_t *result);
Delete all alert from ident stored within result.
|
Pointer to a db object. |
|
Pointer to an idents result object. |
Returns : |
the number of alert deleted on success, or a negative value if an error occur. |
ssize_t preludedb_delete_heartbeat_from_list
(preludedb_t *db,
uint64_t *idents,
size_t isize);
Delete all heartbeat from ident stored within idents.
|
Pointer to a db object. |
|
Pointer to an array of idents. |
|
|
Returns : |
the number of heartbeat deleted on success, or a negative value if an error occur. |
ssize_t preludedb_delete_heartbeat_from_result_idents
(preludedb_t *db,
preludedb_result_idents_t *result);
Delete all heartbeat from ident stored within result.
|
Pointer to a db object. |
|
Pointer to an idents result object. |
Returns : |
the number of heartbeat deleted on success, or a negative value if an error occur. |
int preludedb_get_values (preludedb_t *db,
preludedb_path_selection_t *path_selection,
idmef_criteria_t *criteria,
prelude_bool_t distinct,
int limit,
int offset,
preludedb_result_values_t **result);
|
Pointer to a db object. |
|
Pointer to a path selection. |
|
Pointer to a criteria object. |
|
Get distinct or not distinct result rows. |
|
Limit of results or -1 if no limit. |
|
Offset in results or -1 if no offset. |
|
Values result. |
Returns : |
1 if there are result, 0 if there are none, or a negative value if an error occured. |
int preludedb_transaction_abort (preludedb_t *db);
Abort a sql transaction (SQL ROLLBACK command) initiated
with preludedb_transaction_start(). Internal transaction
handling will be enabled again once this function return.
|
Pointer to a preludedb_t object. |
Returns : |
0 on success or a negative value if an error occur. |
int preludedb_transaction_end (preludedb_t *db);
Terminate a sql transaction (SQL COMMIT command) initiated
with preludedb_transaction_start(). Internal transaction
handling will be enabled again once this function return.
|
Pointer to a preludedb_t object. |
Returns : |
0 on success or a negative value if an error occur. |
int preludedb_transaction_start (preludedb_t *db);
Begin a transaction using db object. Internal transaction
handling will be disabled until preludedb_transaction_end()
or preludedb_transaction_abort() is called.
|
Pointer to a preludedb_t object. |
Returns : |
0 on success or a negative value if an error occur. |