statement.h File Reference

(C) Copyright 2015-2024 Dassault Systemes SE. More...

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

Go to the source code of this file.

Data Structures
struct	NuoDB_BatchResult
	The data structure for the result of a single batch operation. More...
struct	NuoDB_Statement
	The data structure for executing a SQL statement. More...

Typedefs
typedef enum NuoDB_Statement_Flags_enum	NuoDB_Statement_Flags
	Constant flags used by NuoDB_Statement.
typedef enum NuoDB_StatementAnalyze_Flags_enum	NuoDB_StatementAnalyze_Flags
	Constant flags used by NuoDB_Statement.

Enumerations
enum	NuoDB_Statement_Flags_enum {   NUODB_NO_FLAGS = 0x0 ,   NUODB_AUTOGENERATEDKEYS = 0x1 ,   NUODB_EXECUTEQUERY = 0x2 ,   NUODB_EXECUTEUPDATE = 0x4 ,   NUODB_EXECUTECALL = 0x8 }
	Enum defining bitfield flags used by NuoDB_Statement. More...
enum	NuoDB_StatementAnalyze_Flags_enum {   NUODB_ANALYZESTATEMENT_RECORD = 0x1 ,   NUODB_ANALYZESTATEMENT_EXECUTION = 0x2 }
	Enum defining flags used by NuoDB_Statement analyze(). More...

Functions
NUODB_CAPI NuoDB_Statement *NUODB_CAPICALL	NuoDB_Statement_create (NuoDB_Connection *connection)
	Creates a NuoDB_Statement data structure.
NUODB_CAPI void NUODB_CAPICALL	NuoDB_Statement_free (NuoDB_Statement *statement)
	Frees a NuoDB_Statement data structure.

Detailed Description

(C) Copyright 2015-2024 Dassault Systemes SE.

The data structure for executing a SQL statement.

All Rights Reserved.

Enumeration Type Documentation

NuoDB_Statement_Flags_enum

enum NuoDB_Statement_Flags_enum

Enum defining bitfield flags used by NuoDB_Statement.

Enumerator
NUODB_NO_FLAGS	Value indicating there are NO optional flags.
NUODB_AUTOGENERATEDKEYS	flag for statements with automatically generated keys.
NUODB_EXECUTEQUERY	flag for statements that execute a query.
NUODB_EXECUTEUPDATE	flag for statements that update.
NUODB_EXECUTECALL	flag for statements that execute stored procedures. The result parameter, if used, must be registered as an OUT parameter. The other parameters can be used for input, output or both. Parameters are referred to sequentially, by number, with the first parameter being 1. {call <procedure-name>[(<arg1>,<arg2>, ...)]} The type of all OUT parameters must be registered prior to executing the stored procedure; their values are retrieved after execution via the get methods provided here.

NuoDB_StatementAnalyze_Flags_enum

enum NuoDB_StatementAnalyze_Flags_enum

Enum defining flags used by NuoDB_Statement analyze().

Enumerator
NUODB_ANALYZESTATEMENT_RECORD	if set, include statistics on the records contained in the index.
NUODB_ANALYZESTATEMENT_EXECUTION	if set, include information about the execution plan for the statement.

Function Documentation

NuoDB_Statement_create()

NUODB_CAPI NuoDB_Statement *NUODB_CAPICALL NuoDB_Statement_create

(

NuoDB_Connection *

connection

)

Creates a NuoDB_Statement data structure.

This is a factory function for creating NuoDB_Statements from the specified NuoDB_Connection. Clients are expected to call the NuoDB_Statement_free() function which the client is finished with statement.

NuoDB_Statement_free()

NUODB_CAPI void NUODB_CAPICALL NuoDB_Statement_free

(

NuoDB_Statement *

statement

)

Frees a NuoDB_Statement data structure.

Clients should call this function when they are finished with statement.