Collaboration diagram for Fast plain-text write-only DB driver.:

Data Structures

struct flat_cmd
Extension structure of db_cmd adding flatstore specific data. More...
struct flat_con
A structure representing flatstore virtual connections. More...
struct flat_uri
Flatstore driver specific payload to attach to db_uri structures. More...

Files

file flat_cmd.c
Inmplementation of flatstore commands.
file flat_cmd.h
Inmplementation of flatstore commands.
file flat_con.c
Inmplementation of flatstore "connections".
file flat_con.h
Inmplementation of flatstore "connections".
file flat_rpc.c
Flatstore management interface.
file flat_rpc.h
Flatstore management interface.
file flat_uri.c
The implementation of parser parsing flatstore:.
file flat_uri.h
The functions parsing and interpreting flatstore: URIs.
file flatstore_mod.c
Flatstore module interface.
file flatstore_mod.h
Flatstore module interface.

Enumerations

enum flat_con_flags { FLAT_OPENED = (1 << 0) }
Per-connection flags for flatstore connections.
More...

Functions

int flat_cmd (db_cmd_t *cmd)
Creates a new flat_cmd data structure.
static void flat_cmd_free (db_cmd_t *cmd, struct flat_cmd *payload)
Destroys a flat_cmd structure.
int flat_con (db_con_t *con)
Create a new flat_con structure.
static void flat_con_free (db_con_t *con, struct flat_con *payload)
Free all memory allocated for a flat_con structure.
int flat_put (db_res_t *res, db_cmd_t *cmd)
The main execution function in flat SER driver.
int flat_uri (db_uri_t *uri)
Create a new flat_uri structure and convert the path in parameter.
static void rotate (rpc_t *rpc, void *c)
Register a new file rotation request.

Variables

str flat_delimiter
Field delimiter.
str flat_delimiter = STR_STATIC_INIT("|")
Field delimiter.
str flat_escape = STR_STATIC_INIT("\\")
Escape character.
str flat_escape
Escape character.
int flat_flush
Enable/disable flushing after eaach write.
int flat_flush = 1
Enable/disable flushing after eaach write.
time_t flat_local_timestamp
Timestamp of last file rotation.
time_t flat_local_timestamp
Timestamp of last file rotation.
str flat_pid = STR_NULL
PID to be used in file names.
str flat_pid
PID to be used in file names.
str flat_record_delimiter
Row delimiter.
str flat_record_delimiter = STR_STATIC_INIT("\n")
Row delimiter.
time_t * flat_rotate
Timestamp of last file rotation request.
time_t * flat_rotate
Timestamp of last file rotation request.
str flat_suffix
Filename suffix.
str flat_suffix = STR_STATIC_INIT(".log")
Filename suffix.

Enumeration Type Documentation

enum flat_con_flags

Enumerator:

FLAT_OPENED

Handle opened successfully.

Definition at line 46 of file flat_con.h.

Function Documentation

int flat_cmd ( db_cmd_t * cmd )

This function allocates and initializes memory for a new flat_cmd data structure. The data structure is then attached to the generic db_cmd structure in cmd parameter.

Parameters:

cmd

A generic db_cmd structure to which the newly created flat_cmd structure will be attached.

static void flat_cmd_free	(	db_cmd_t *	cmd,
		struct flat_cmd *	payload
	)			`[static]`

This function frees all memory used by flat_cmd structure.

Parameters:

	cmd	A pointer to generic db_cmd command being freed.
	payload	A pointer to flat_cmd structure to be freed.

Definition at line 48 of file flat_cmd.c.

References flat_cmd::gen.

int flat_con ( db_con_t * con )

This function creates a new flat_con structure and attachs the structure to the generic db_con structure in the parameter.

Parameters:

con

A generic db_con structure to be extended with flatstore payload

Return values:

	0	on success
	A	negative number on error

static void flat_con_free	(	db_con_t *	con,
		struct flat_con *	payload
	)			`[static]`

This function function frees all memory that is in use by a flat_con structure.

Parameters:

	con	A generic db_con connection structure.
	payload	Flatstore specific payload to be freed.

Definition at line 53 of file flat_con.c.

int flat_put	(	db_res_t *	res,
		db_cmd_t *	cmd
	)

This is the main execution function in this driver. It is executed whenever a SER module calls db_exec and the target database of the commands is flatstore.

Parameters:

res

A pointer to (optional) result structure if the command returns a result.

Return values:

	0	if executed successfully
	A	negative number if the database server failed to execute command
	A	positive number if there was an error on client side (SER)

int flat_uri ( db_uri_t * uri )

This function builds a new flat_uri structure from the body of the generic URI given to it in parameter.

Parameters:

uri

A generic db_uri structure.

Return values:

	0	on success
	A	negative number on error.

static void rotate	(	rpc_t *	rpc,
		void *	c
	)			`[static]`

This function can be called through the management interface in SER and it will register a new file rotation request. This function only registers the request, it will be carried out next time SER attempts to write new data into the file.

Definition at line 44 of file flat_rpc.c.

References flat_rotate.

Variable Documentation

str flat_delimiter

The character in this variable will be used to delimit fields.

Definition at line 77 of file flatstore_mod.c.

str flat_delimiter = STR_STATIC_INIT("|")

The character in this variable will be used to delimit fields.

Definition at line 77 of file flatstore_mod.c.

str flat_escape = STR_STATIC_INIT("\\")

The character in this variable will be used to escape specia characters, such as row and field delimiters, if they appear in the data being written in the files.

Definition at line 85 of file flatstore_mod.c.

str flat_escape

The character in this variable will be used to escape specia characters, such as row and field delimiters, if they appear in the data being written in the files.

Definition at line 85 of file flatstore_mod.c.

int flat_flush

Definition at line 65 of file flatstore_mod.c.

int flat_flush = 1

Definition at line 65 of file flatstore_mod.c.

time_t flat_local_timestamp

This variable contains the time of the last rotation of files.

Definition at line 104 of file flatstore_mod.c.

time_t flat_local_timestamp

This variable contains the time of the last rotation of files.

Definition at line 104 of file flatstore_mod.c.

str flat_pid = STR_NULL

The flatstore module generates one file per SER process to ensure that every SER process has its own file and no locking/synchronization is necessary. This variable contains a unique id of the SER process which will be added to the file name.

Definition at line 61 of file flatstore_mod.c.

str flat_pid

The flatstore module generates one file per SER process to ensure that every SER process has its own file and no locking/synchronization is necessary. This variable contains a unique id of the SER process which will be added to the file name.

Definition at line 61 of file flatstore_mod.c.

str flat_record_delimiter

The character in this variable will be used to delimit rows.

Definition at line 71 of file flatstore_mod.c.

str flat_record_delimiter = STR_STATIC_INIT("\n")

The character in this variable will be used to delimit rows.

Definition at line 71 of file flatstore_mod.c.

time_t* flat_rotate

This variable holds the timestamp of the last file rotation request received through the management interface.

Definition at line 98 of file flatstore_mod.c.

Referenced by rotate().

time_t* flat_rotate