Index

• Main YottaDB Documentation Page
• Multi-Language Programmer's Guide
  • Overview
  • Quick Start
    • Local Installation
    • Docker Container
  • Concepts
    • Keys, Values, Nodes, Variables, and Subscripts
      • Variables vs. Subscripts vs. Values
    • Local and Global Variables
    • Global Directories
      • Client/Server Operation
    • Intrinsic Special Variables
      • $tlevel
      • $trestart
      • $zgbldir
      • $zmaxtptime
      • $zstatus
      • $zyrelease
    • Transaction Processing
      • Nested Transactions
    • Locks
      • Locks and Transaction Processing
• Programming in M
• Programming in C
  • Sample Program
  • Symbolic Constants
    • Function Return Codes
      • Normal Return Codes
        • YDB_LOCK_TIMEOUT
        • YDB_OK
        • YDB_TP_RESTART
        • YDB_TP_ROLLBACK
      • Error Return Codes
        • YDB_ERR_CALLINAFTERXIT
        • YDB_ERR_FATALERROR1
        • YDB_ERR_FATALERROR2
        • YDB_ERR_GVUNDEF
        • YDB_ERR_INVNAMECOUNT
        • YDB_ERR_INSUFFSUBS
        • YDB_ERR_INVSTRLEN
        • YDB_ERR_INVSVN
        • YDB_ERR_INVVARNAME
        • YDB_ERR_KEY2BIG
        • YDB_ERR_LVUNDEF
        • YDB_ERR_MAXNRSUBSCRIPTS
        • YDB_ERR_MINNRSUBSCRIPTS
        • YDB_ERR_NAMECOUNT2HI
        • YDB_ERR_NODEEND
        • YDB_NOTOK
        • YDB_ERR_NUMOFLOW
        • YDB_ERR_PARAMINVALID
        • YDB_ERR_SIMPLEAPINEST
        • YDB_ERR_SUBSARRAYNULL
        • YDB_ERR_SVNOSET
        • YDB_ERR_TIME2LONG
        • YDB_ERR_TPTIMEOUT
        • YDB_ERR_UNIMPLOP
        • YDB_ERR_VARNAME2LONG
    • Limits
      • YDB_MAX_IDENT
      • YDB_MAX_M_LINE_LEN
      • YDB_MAX_NAMES
      • YDB_MAX_STR
      • YDB_MAX_SUBS
      • YDB_MAX_TIME_NSEC
      • YDB_MAX_YDBERR
      • YDB_MIN_YDBERR
    • Severity
      • YDB_SEVERITY_ERROR
      • YDB_SEVERITY_FATAL
      • YDB_SEVERITY_INFORMATIONAL
      • YDB_SEVERITY_SUCCESS
      • YDB_SEVERITY_WARNING
    • Other
      • YDB_DEL_NODE and YDB_DEL_TREE
      • YDB_NOTTP
  • Data Structures & Type Definitions
    • ydb_buffer_t
    • ydb_string_t
    • ydb_tpfnptr_t
    • ydb_tp2fnptr_t
  • Macros
    • YDB_ASSERT(x)
    • YDB_BUFFER_IS_SAME(buffer1, buffer2)
    • YDB_COPY_BUFFER_TO_BUFFER(source, destination, done)
    • YDB_COPY_LITERAL_TO_BUFFER(literal, buffer, done)
    • YDB_COPY_STRING_TO_BUFFER(string, buffer, done)
    • YDB_FREE_BUFFER(BUFFERP)
    • YDB_LITERAL_TO_BUFFER(literal, buffer)
    • YDB_IS_YDBERR(msgnum)
    • YDB_MALLOC_BUFFER(BUFFERP,LEN)
    • YDB_SEVERITY(msgnum, severity)
    • HASH128_STATE_INIT(hash128_state_t *state, ydb_uint8 addl_seed)
    • YDB_STRING_TO_BUFFER
  • Simple API
    • ydb_data_s() / ydb_data_st()
    • ydb_delete_s() / ydb_delete_st()
    • ydb_delete_excl_s() / ydb_delete_excl_st()
    • ydb_get_s() / ydb_get_st()
    • ydb_incr_s() / ydb_incr_st()
    • ydb_lock_s() / ydb_lock_st()
    • ydb_lock_decr_s() / ydb_lock_decr_st()
    • ydb_lock_incr_s() / ydb_lock_incr_st()
    • ydb_node_next_s() / ydb_node_next_st()
    • ydb_node_previous_s() / ydb_node_previous_st()
    • ydb_set_s() / ydb_set_st()
    • ydb_str2zwr_s() / ydb_str2zwr_st()
    • ydb_subscript_next_s() / ydb_subscript_next_st()
    • ydb_subscript_previous_s() / ydb_subscript_previous_st()
    • ydb_tp_s() / ydb_tp_st()
    • ydb_zwr2str_s() / ydb_zwr2str_st()
  • Comprehensive API
  • YottaDB C to M APIs
  • Utility Functions
    • ydb_call_variadic_plist_func()
    • ydb_child_init()
    • ydb_eintr_handler() / ydb_eintr_handler_t()
    • ydb_exit()
    • ydb_file_id_free() / ydb_file_id_free_t()
    • ydb_file_is_identical() / ydb_file_is_identical_t()
    • ydb_file_name_to_id() / ydb_file_name_to_id_t()
    • ydb_fork_n_core()
    • ydb_free()
    • ydb_hiber_start()
    • ydb_hiber_start_wait_any()
    • ydb_init()
    • ydb_malloc()
    • ydb_message() / ydb_message_t()
    • ydb_mmrhash_32()
    • ydb_mmrhash_128()
    • ydb_mmrhash_128_ingest() / ydb_mmrhash_128_result()
    • ydb_mmrhash_128_hex()
    • ydb_mmrhash_128_bytes()
    • ydb_stdout_stderr_adjust() / ydb_stdout_stderr_adjust_t()
    • ydb_thread_is_main()
    • ydb_timer_cancel() / ydb_timer_cancel_t()
    • ydb_timer_start() / ydb_timer_start_t()
  • Calling M Routines
• Programming in Go
  • Go Quick Start
  • Go Concepts
    • Go Error Interface
      • Go Error Return Codes
        • DBRNDWNBYPASS
        • INVLKNMPAIRLIST
        • SIGACKTIMEOUT
        • SIGGORTNTIMEOUT
        • STRUCTUNALLOCD
  • Go Constants
  • Go Symbolic Constants
  • Go Easy API
    • Go Easy API Functions
  • Go Simple API
  • Go Data Structures & Type Definitions
  • Go Wrapper Functions
    • Go CallMT()
    • Go DataE()
    • Go DeleteE()
    • Go DeleteExclE()
    • Go ErrorCode()
    • Go Exit()
    • Go IncrE()
    • Go Init()
    • Go IsLittleEndian()
    • Go LockDecrE()
    • Go LockE()
    • Go LockIncrE()
    • Go LockST()
    • Go MessageT()
    • Go NewError()
    • Go NodeNextE()
    • Go NodePrevE()
    • Go RegisterSignalNotify()
    • Go ReleaseT()
    • Go SetValE()
    • Go SubNextE()
    • Go SubPrevE()
    • Go TpE()
    • Go UnRegisterSignalNotify()
    • Go ValE()
    • Go BufferT Alloc()
    • Go BufferT Dump()
    • Go BufferT DumpToWriter()
    • Go BufferT Free()
    • Go BufferT LenAlloc()
    • Go BufferT LenUsed()
    • Go BufferT SetLenUsed()
    • Go BufferT SetValBAry()
    • Go BufferT SetValStr()
    • Go BufferT Str2ZwrST()
    • Go BufferT ValBAry()
    • Go BufferT ValStr()
    • Go BufferT Zwr2StrST()
    • Go BufferTArray Alloc()
    • Go BufferTArray DeleteExclST()
    • Go BufferTArray Dump()
    • Go BufferTArray DumpToWriter()
    • Go BufferTArray ElemAlloc()
    • Go BufferTArray ElemLenAlloc()
    • Go BufferTArray ElemLenUsed()
    • Go BufferTArray ElemUsed()
    • Go BufferTArray Free()
    • Go BufferTArray SetElemLenUsed()
    • Go BufferTArray SetElemUsed()
    • Go BufferTArray SetValBAry()
    • Go BufferTArray SetValStr()
    • Go BufferTArray TpST()
    • Go BufferTArray ValBAry()
    • Go BufferTArray ValStr()
    • Go CallMDesc CallMDescT()
    • Go CallMDesc Free()
    • Go CallMDesc SetRtnName()
    • Go CallMTable CallMTableOpenT()
    • Go CallMTable CallMTableSwitchT()
    • Go KeyT Alloc()
    • Go KeyT DataST()
    • Go KeyT DeleteST()
    • Go KeyT Dump()
    • Go KeyT DumpToWriter()
    • Go KeyT Free()
    • Go KeyT IncrST()
    • Go KeyT LockDecrST()
    • Go KeyT LockIncrST()
    • Go KeyT NodeNextST()
    • Go KeyT NodePrevST()
    • Go KeyT SetValST()
    • Go KeyT SubNextST()
    • Go KeyT SubPrevST()
    • Go KeyT ValST()
    • Go Error()
  • Go Programming Notes
    • Goroutines
    • Go Using Signals
    • Database Integrity
• Programming in JavaScript
  • Installation
  • Nodem API
    • Nodem Wrapper Functions
      • data()
      • get()
      • increment()
      • kill()
      • lock()
      • nextNode()
      • order()/next()
      • previous()
      • previousNode()
      • set()
      • transaction()
      • unlock()
    • Other API Functions
      • close()
      • configure()
      • function()
      • globalDirectory()
      • localDirectory()
      • merge()
      • open()
      • procedure()/routine()
      • version()/about()
  • Programming Notes
    • Calling M routines
    • GT.CM Client
    • Character Encodings
    • Data Handling
    • Debugging Mode
    • Signal Handling
    • Auto-relinking
    • Asynchronous Calls
    • Restoring Terminal Settings
    • Worker Threads API
• Programming in Lua
  • Installation
  • Introduction by example
  • Lua API
    • Low level wrapper functions
      • block_M_signals (bool)
      • data (varname[, subsarray[, …]])
      • delete_node (varname[, subsarray[, …]])
      • delete_tree (varname[, subsarray[, …]])
      • get (varname[, subsarray[, …]])
      • get_error_code (message)
      • incr (varname[, subsarray][, …], increment)
      • init ([signal_blocker])
      • lock ([nodes[, timeout]])
      • lock_decr (varname[, subsarray[, …]])
      • lock_incr (varname[, subsarray[, …[, timeout]]])
      • node_next (varname[, subsarray[, …]])
      • node_previous (varname[, subsarray[, …]])
      • set (varname[, subsarray][, …], value)
      • str2zwr (s)
      • subscript_next (varname[, subsarray[, …]])
      • subscript_previous (varname[, subsarray[, …]])
      • subscripts (varname[, subsarray[, …[, reverse]]])
      • ydb_eintr_handler ()
      • zwr2str (s)
    • Transactions
      • tp ([id][, varnames], f[, …])
      • transaction ([id][, varnames], f)
      • trestart ()
      • trollback ()
    • High level functions
      • dump (node[, …[, maxlines=30]])
      • require (Mprototypes)
    • Class node
      • node (varname[, subsarray][, …], node)
      • node:__ipairs ()
      • node:__pairs ([reverse])
      • node:delete_tree ()
      • node:dump ([maxlines=30])
      • node:get ([default])
      • node:gettree ([maxdepth[, filter[, _value[, _depth]]]])
      • node:incr ([increment=1])
      • node:lock ([timeout])
      • node:lock_decr ()
      • node:lock_incr ([timeout])
      • node:set (value)
      • node:settree (tbl[, filter[, _seen]])
      • node:subscripts ([reverse])
    • Node properties
      • node:data ()
      • node:depth ()
      • node:has_tree ()
      • node:has_value ()
      • node:ismutable ()
      • node:name ()
      • node:subsarray ()
      • node:varname ()
    • Class key
      • key (varname[, subsarray])
      • key._property_
      • key:delete_node ()
      • key:subscript_next ([reset[, reverse]])
      • key:subscript_previous ([reset])
      • key:subscripts ([reverse])
• Programming in Perl
  • Perl Quick Start
  • Functions
    • $data = y_data $var [, @subs]
    • y_killall ()
    • y_kill_excl [$var0 [,$var1 [,…]]]
    • y_kill_node $var [, @subs]
    • y_kill_tree $var [, @subs]
    • y_set $var, [@subs,] $value
    • $value = y_get $var [, @subs]
    • $value = y_get_croak $var [, @subs]
    • $value = y_next $var [, @subs]
    • $value = y_previous $var [, @subs]
    • (@subs) = y_node_next $var [, @subs]
    • (@subs) = y_node_previous $var [, @subs]
    • $incval = y_incr $var [, @subs], $increment
    • $string = y_zwr2str $zwr_encoded_string
    • $zwrstring = y_str2zwr $string
    • $status = y_lock $timeout [, @name1 [, @name2 [,…]]]
    • $status = y_lock_incr $timeout, $var [, @subs]
    • y_lock_decr $var [, @subs]
    • $status = y_trans (&code, $tansid [, lvar0 [, lvar1 …]])
• Programming in PHP
• Programming in Python
  • Python Quick Start
  • Python Concepts
    • Python Exception Handling
  • Python Symbolic Constants
  • Python API
    • Python API Functions
  • Python Data Structures & Type Definitions
  • Python Wrapper Functions
    • Python ci()
    • Python cip()
    • Python data()
    • Python delete_node()
    • Python delete_tree()
    • Python get()
    • Python incr()
    • Python lock()
    • Python lock_decr()
    • Python lock_incr()
    • Python message()
    • Python node_next()
    • Python node_previous()
    • Python nodes()
    • Python open_ci_table()
    • Python release()
    • Python set()
    • Python str2zwr()
    • Python subscript_next()
    • Python subscript_previous()
    • Python subscripts()
    • Python switch_ci_table()
    • Python tp()
    • Python transaction()
    • Python zwr2str()
  • YottaDB Key class properties
    • Key.data
    • Key.has_value
    • Key.has_tree
    • Key.subsarray
    • Key.subscripts
    • Key.subsarray_keys
    • Key.value
    • Key.varname_key
    • Key.varname
  • YottaDB Key class regular methods
    • Key.delete_node()
    • Key.delete_tree()
    • Key.get()
    • Key.incr()
    • Key.load_json()
    • Key.load_tree()
    • Key.lock()
    • Key.lock_decr()
    • Key.lock_incr()
    • Key.node_next()
    • Key.replace_tree()
    • Key.save_json()
    • Key.save_tree()
    • Key.set()
    • Key.subscript_next()
    • Key.subscript_previous()
  • YottaDB Key class magic methods
    • Key.__eq__()
    • Key.__getitem__()
    • Key.__iadd__()
    • Key.__init__()
    • Key.__isub__()
    • Key.__iter__()
    • Key.__repr__()
    • Key.__reversed__()
    • Key.__setitem__()
    • Key.__str__()
• Programming in Rust
  • Getting Started
    • Install YottaDB
    • Install Rust
    • Install YDBRust
  • Rust API
    • Macros
      • ci_t
      • cip_t
      • make_ckey
      • make_key
    • Struct yottadb::Context
      • delete_excl()
      • eintr_handler()
      • lock()
      • new()
      • new_key()
      • str2zwr()
      • tp()
      • tptoken()
      • zwr2str()
      • Call-in functions
        • ci_tab_open()
        • ci_tab_switch()
      • Utility Functions
        • message()
        • release()
    • Struct yottadb::KeyContext
      • data()
      • delete()
      • get()
      • get_and_parse()
      • increment()
      • iter_key_nodes()
      • iter_key_nodes_reverse()
      • iter_key_subs()
      • iter_key_subs_reverse()
      • iter_nodes()
      • iter_nodes_reverse()
      • iter_subs()
      • iter_subs_reverse()
      • iter_subs_values()
      • iter_subs_values_reverse()
      • iter_values()
      • iter_values_reverse()
      • lock_decr()
      • lock_incr()
      • new()
      • next_node()
      • next_node_self()
      • next_sub()
      • next_sub_self()
      • prev_node()
      • prev_node_self()
      • prev_sub()
      • prev_sub_self()
      • set()
      • variable()
      • with_key()
  • Advantages of the Rust wrapper
• Programming Notes (Avoiding Common Pitfalls)
  • Numeric Considerations
    • Canonical Numbers
  • Zwrite Format
  • Signals
  • Forking
  • Threads
    • Threads and Transaction Processing
  • Timers and Timeouts
  • Memory Allocation
  • Syslog
  • IO
• LICENSE

Indices and tables

• Index

• Search Page