XINA Documentation

XINA Documentation

  • Docs
  • API

›API

XINA

  • Overview
  • Data Types
  • Tasks

Utilities

  • XINA Tunnel

API

  • Overview
  • Data Actions
  • Admin Actions
  • Specifier Syntax
  • Data Syntax
  • Expression Syntax
  • Select Syntax
  • Definitions Syntax

Definitions Syntax

Under Construction

Group

Defines a XINA group.

PropertyValue
namestring
descstring

Database

Defines a XINA database. The name and fields values are required, and at least one field must be provided. If label is not provided it will be the same as name.

PropertyValue
namestring
labelstring (optional)
formatstring (optional)
pathstring (optional)
descstring (optional)
dynamicboolean (optional, default false)
eventboolean (optional, default false)
fileboolean (optional, default false)
linkboolean (optional, default false)
lockboolean (optional, default false)
logboolean (optional, default false)
notifyboolean (optional, default false)
subscribeboolean (optional, default false)
tagboolean (optional, default false)
trackboolean (optional, default false)
trashboolean (optional, default false)
wallboolean (optional, default false)
objectsobject (optional)
filesobject (optional)
fieldsarray of fields
blobsarray of blobs (optional)
indexesarray of string values (optional)
databasesarray of databases (optional)

Field

Defines a XINA database field. The name and type are required. If label is not provided it will be the same as name.

{ "name" : , "label" : , (optional) "type" : , "format" : , (optional) "meas" : , (optional) "unit" : , (optional) "desc" : , (optional) "def" : , (optional) "ref" : , (optional) "key" : , (optional, default false) "nul" : , (optional, default false) "strict" : , (optional, default false) "lock" : , (optional, default false) "options" : [ <[[#Field Option|field option]]>, ... ] (optional) }

Field Option

A value option for a field. Regardless of the field type the value here should be a string representation of the actual value.

{ "value" : , "desc" : (optional) }

Blob

Defines a XINA database blob. The name is required. If label is not provided it will be the same as name.

{ "name" : , "label" : , (optional) "desc" : , (optional) "nul" : (optional, default false) }

Index

Defines an index on one or more columns of a database record table.

← Select Syntax
  • Group
  • Database
    • Field
    • Blob
    • Index
XINA Documentation
Docs
OverviewAPI Reference
Community
User ShowcaseStack OverflowProject ChatTwitter
More
BlogGitHubStar
Facebook Open Source
Copyright © 2020 Linear Labs LLC