mksqlite  2.5
A MATLAB interface to SQLite
Macros | Enumerations
config.h File Reference

Global configuration settings and defaults. More...

+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define CONFIG_USE_HEAP_CHECK   BOOL_FALSE
 false=standard allocators, true=usage of heap_check.hpp More...
 
#define CONFIG_NULL_AS_NAN   BOOL_FALSE
 use NaN instead of NULL values by default
 
#define CONFIG_BUSYTIMEOUT   1000
 default SQL busy timeout in milliseconds (1000)
 
#define CONFIG_COMPRESSION_LEVEL   0
 compression level: Using compression on typed blobs when > 0 More...
 
#define CONFIG_COMPRESSION_TYPE   NULL
 "blosc", "blosclz", "qlin16", "qlog16" or NULL (for default)
 
#define CONFIG_COMPRESSION_CHECK   BOOL_TRUE
 Flag: check compressed against original data. More...
 
#define CONFIG_CONVERT_UTF8   BOOL_TRUE
 Convert UTF-8 to ascii, otherwise set slCharacterEncoding('UTF-8') More...
 
#define CONFIG_MKSQLITE_VERSION_STRING   "2.5"
 mksqlite version string
 
#define CONFIG_MAX_NUM_OF_DBS   10
 maximum number of databases, simultaneous open
 
#define CONFIG_CHECK_4_UNIQUE_FIELDS   BOOL_TRUE
 ensure unique fields in query return structure by default
 
#define CONFIG_STREAMING   BOOL_FALSE
 Allow streaming to convert MATLAB variables into byte streams. More...
 
#define CONFIG_MKSQLITE_MAX_BLOB_SIZE   ((mwSize)INT32_MAX)
 SQLite itself limits BLOBs to 1MB, mksqlite limits to INT32_MAX. More...
 
#define CONFIG_RESULT_TYPE   RESULT_TYPE_ARRAYOFSTRUCTS
 Data organisation of query results. More...
 
#define CONFIG_PARAM_WRAPPING   BOOL_FALSE
 Wrap parameters. More...
 

Enumerations

enum  RESULT_TYPES { RESULT_TYPE_ARRAYOFSTRUCTS, RESULT_TYPE_STRUCTOFARRAYS, RESULT_TYPE_MATRIX, RESULT_TYPE_MAX_ID = RESULT_TYPE_MATRIX }
 MATLAB specific configurations. More...
 

Detailed Description

Global configuration settings and defaults.

Configuration file for settings and defaults

Authors
Martin Kortmann mail@.nosp@m.kort.nosp@m.mann..nosp@m.de, Andreas Martin andim.nosp@m.arti.nosp@m.n@use.nosp@m.rs.s.nosp@m.ource.nosp@m.forg.nosp@m.e.net
Version
2.5
Date
2008-2017
Precondition
Warning
Bug:

Definition in file config.h.

Macro Definition Documentation

◆ CONFIG_COMPRESSION_CHECK

#define CONFIG_COMPRESSION_CHECK   BOOL_TRUE

Flag: check compressed against original data.

check is on by default

Definition at line 32 of file config.h.

◆ CONFIG_COMPRESSION_LEVEL

#define CONFIG_COMPRESSION_LEVEL   0

compression level: Using compression on typed blobs when > 0

no compression by default

Definition at line 28 of file config.h.

◆ CONFIG_CONVERT_UTF8

#define CONFIG_CONVERT_UTF8   BOOL_TRUE

Convert UTF-8 to ascii, otherwise set slCharacterEncoding('UTF-8')

use UTF8 encoding by default

Definition at line 35 of file config.h.

◆ CONFIG_MKSQLITE_MAX_BLOB_SIZE

#define CONFIG_MKSQLITE_MAX_BLOB_SIZE   ((mwSize)INT32_MAX)

SQLite itself limits BLOBs to 1MB, mksqlite limits to INT32_MAX.

max. size in bytes of a blob

Definition at line 63 of file config.h.

◆ CONFIG_PARAM_WRAPPING

#define CONFIG_PARAM_WRAPPING   BOOL_FALSE

Wrap parameters.

paramter wrapping is off by default

Definition at line 75 of file config.h.

◆ CONFIG_RESULT_TYPE

#define CONFIG_RESULT_TYPE   RESULT_TYPE_ARRAYOFSTRUCTS

Data organisation of query results.

Early bind mxSerialize and mxDeserialize BOOL_TRUE: mksqlite has to be linked with MATLAB lib, BOOL_FALSE: dynamic calls to MATLAB functionsreturn array of structs by default

Definition at line 72 of file config.h.

◆ CONFIG_STREAMING

#define CONFIG_STREAMING   BOOL_FALSE

Allow streaming to convert MATLAB variables into byte streams.

streaming is disabled by default

Definition at line 60 of file config.h.

◆ CONFIG_USE_HEAP_CHECK

#define CONFIG_USE_HEAP_CHECK   BOOL_FALSE

false=standard allocators, true=usage of heap_check.hpp

When defined, MEM_ALLOC, MEM_REALLOC and MEM_FREE actions were monitored and some simple boundary checks will be made.

Enumeration Type Documentation

◆ RESULT_TYPES

MATLAB specific configurations.

result types

See also
STR_RESULT_TYPES in locale.hpp
Enumerator
RESULT_TYPE_ARRAYOFSTRUCTS 

Array of structs.

RESULT_TYPE_STRUCTOFARRAYS 

Struct of arrays.

RESULT_TYPE_MATRIX 

Matrix/cell array.

RESULT_TYPE_MAX_ID 

Limit for bound checking only.

Definition at line 45 of file config.h.