NuoDB Large Object. More...

#include "nuodb/utils.h"
#include "nuodb/structs.h"
#include "nuodb/error.h"

Data Structures
struct	NuoDB_Lob
	NuoDB Large Object More...

Typedefs
typedef enum NuoDB_Lob_Type_enum	NuoDB_Lob_Type
	Large object types used by NuoDB_Lob.

Enumerations
enum	NuoDB_Lob_Type_enum { NUODB_BLOB_TYPE = 1 , NUODB_CLOB_TYPE = 2 , NUODB_BYTES_TYPE = 3 }
	Enum defining large object types used by NuoDB_Lob. More...

Functions
NUODB_CAPI NuoDB_Lob *NUODB_CAPICALL	NuoDB_Lob_create (NuoDB_Connection *connection, NuoDB_Lob_Type type)
	Create a NuoDB_Lob data structure.

NUODB_CAPI void NUODB_CAPICALL	NuoDB_Lob_free (NuoDB_Lob *lob)
	Free a NuoDB_Lob data structure.

Detailed Description

NuoDB Large Object.

Enumeration Type Documentation

◆ NuoDB_Lob_Type_enum

enum NuoDB_Lob_Type_enum

Enum defining large object types used by NuoDB_Lob.

Enumerator

NUODB_BLOB_TYPE

Representation of a Binary Large Object value to be stored as a column value in a row of a table.

A SQL BLOB is a built-in data type that stores a Binary Large Object as a column value in a row of a database table.

See Binary Data Types in the NuoDB Documentation for more information about this data type.

NUODB_CLOB_TYPE

Representation of a Character Large Object (CLOB) value to be stored as a column value in a row of a table.

A SQL CLOB is a built-in data type that stores a Character Large Object as a column value in a row of a database table.

NUODB_BYTES_TYPE

Representation of Binary to be stored as a column value in a row of a table.

A SQL BINARY is a built-in data type that stores a Bytes as a column value in a row of a database table.

Function Documentation

◆ NuoDB_Lob_create()

NUODB_CAPI NuoDB_Lob *NUODB_CAPICALL NuoDB_Lob_create	(	NuoDB_Connection *	connection,
		NuoDB_Lob_Type	type )

Create a NuoDB_Lob data structure.

NuoDB_Lob is a container for various Large Objects. Clients must create a NuoDB_Lob data structure when passing any of the following Large Object types to a prepared statement. It is the responsibility of the caller to call NuoDB_Lob_free() when the caller is finished with it.

Parameters

[in]	connection	a pointer to the connection.
[in]	type	valid types are: NUODB_BLOB_TYPE = 1 NUODB_CLOB_TYPE = 2 NUODB_BYTES_TYPE = 3

Returns: a pointer to a NuoDB_Lob data structure

◆ NuoDB_Lob_free()

NUODB_CAPI void NUODB_CAPICALL NuoDB_Lob_free ( NuoDB_Lob * lob )

Free a NuoDB_Lob data structure.

Clients should call this function to free the NuoDB_Lob.

Data Structures

Typedefs