C Driver API 3.0.0
API for the NuoDB C Driver Library
Loading...
Searching...
No Matches
temporal.h File Reference

Data structure used to represent temporal information. More...

#include <time.h>
#include "nuodb/utils.h"
#include "nuodb/structs.h"

Go to the source code of this file.

Data Structures

struct  NuoDB_Temporal
 Data structure used to represent temporal information. More...
 

Typedefs

typedef enum NuoDB_Temporal_Type_enum NuoDB_Temporal_Type
 Constant temporal types used by NuoDB_Temporal.
 

Enumerations

enum  NuoDB_Temporal_Type_enum {
  NUODB_TEMPORAL_DATE = 1 ,
  NUODB_TEMPORAL_TIME = 2 ,
  NUODB_TEMPORAL_TIMESTAMP = 3 ,
  NUODB_TEMPORAL_TIMESTAMP_NO_TZ = 4
}
 Enum defining constant temporal types used by NuoDB_Temporal. More...
 

Functions

NUODB_CAPI NuoDB_Temporal *NUODB_CAPICALL NuoDB_Temporal_create (NuoDB_Temporal_Type temporalType)
 Create a NuoDB_Temporal data structure for the specified SQL type.
 
NUODB_CAPI void NUODB_CAPICALL NuoDB_Temporal_free (NuoDB_Temporal *temporal)
 Free the NuoDB_Temporal data structure.
 
NUODB_CAPI void NUODB_CAPICALL NuoDB_Temporal_init (NuoDB_Temporal *tm, NuoDB_Temporal_Type temporalType)
 Initialize a NuoDB_Temporal data structure with the specified SQL type.
 
NUODB_CAPI const NuoDB_Timezone *NUODB_CAPICALL NuoDB_Timezone_create (const char *timezoneId)
 Create a NuoDB_Timezone data structure for the specified timezone id.
 
NUODB_CAPI void NUODB_CAPICALL NuoDB_Timezone_free (const NuoDB_Timezone *timezone)
 Free the NuoDB_Timezone data structure.
 

Detailed Description

Data structure used to represent temporal information.

Enumeration Type Documentation

◆ NuoDB_Temporal_Type_enum

Enum defining constant temporal types used by NuoDB_Temporal.

Enumerator
NUODB_TEMPORAL_DATE 

SQL DATE type.

NUODB_TEMPORAL_TIME 

SQL TIME type.

NUODB_TEMPORAL_TIMESTAMP 

SQL TIMESTAMP type.

NUODB_TEMPORAL_TIMESTAMP_NO_TZ 

SQL TIMESTAMP WITHOUT TIME ZONE type.

Function Documentation

◆ NuoDB_Temporal_create()

NUODB_CAPI NuoDB_Temporal *NUODB_CAPICALL NuoDB_Temporal_create ( NuoDB_Temporal_Type temporalType)

Create a NuoDB_Temporal data structure for the specified SQL type.

The client is expected to call NuoDB_Temporal_free() when it is no longer using the NuoDB_Temporal data structure.

◆ NuoDB_Timezone_create()

NUODB_CAPI const NuoDB_Timezone *NUODB_CAPICALL NuoDB_Timezone_create ( const char * timezoneId)

Create a NuoDB_Timezone data structure for the specified timezone id.

The client is expected to call NuoDB_Timezone_free() when it is no longer using the data structure.