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

Data Syntax

Records

Provides the data for one or more records.

Array

Provides record data as an array of record objects.

[ <[[#Record|record]]> ... ]

DSV

Provides record data as a delimiter separated values file. See the [[XINA API :: DSV Format|DSV format]] page for the syntax and more information.

Record

Provides data for a single record as a JSON object.

PropertyValue
field name or label
blob name or label
tags
file

DSV Format

Certain types of data may be provided in a delimiter separated values format.

The default format of the separated values files is largely based on the RFC 4180 standard. The specific requirements are:

  • lines end with CR LF
  • line breaks cannot be used in values
  • any field may be escaped
  • the default quote character is " (double quotes)
  • any field containing the delimiter must be quoted
  • an escape character in an escaped field must be represented by two escape characters
  • the first record (row) must contain the names of each field for entries, or each group field for items
  • blank lines with no data are ignored

DSV

The basic DSV format must explicitly specify a delimiter.

{ "type": "dsv", "object_id": , "delimit": , "quote": , (optional) "line": (optional) }

TSV

The TSV format uses TAB as the default delimiter, but it may be overridden.

{ "type": "tsv", "object_id": , "delimit": , (optional) "quote": , (optional) "line": (optional) }

CSV

The CSV format uses , (comma) as the default delimiter, but it may be overridden.

{ "type": "csv", "object_id": , "delimit": , (optional) "quote": , (optional) "line": (optional) }

← Specifier SyntaxExpression Syntax →
  • Records
    • Array
    • DSV
  • Record
  • DSV Format
    • DSV
    • TSV
    • CSV
XINA Documentation
Docs
OverviewAPI Reference
Community
User ShowcaseStack OverflowProject ChatTwitter
More
BlogGitHubStar
Facebook Open Source
Copyright © 2020 Linear Labs LLC