RevealcoreArraySchema: Revealcore array schema

In Paradigm4/revealcore: SciDB REVEAL Core API

Revealcore array schema

Description

Revealcore array schema

Revealcore array schema

Public fields

entity_name

The name of the entity, which must be unique within the package schema. The full array name of the entity will be ⁠{namespace}.{entity_name}⁠

entity_id

A (package-unique) id for the entity, or -1 if the entity does not have one

namespace

The namespace where the entity can be found. The full array name of the entity will be ⁠{namespace}.{entity_name}⁠

attributes

A named vector of array attributes, with the attribute names as the list names and the scidb type of the attribute as the value

unique_fields

A list of attributes and dimension names that correspond to a unique entry in the array

unique_fields_dim

A single array dimension. If set, a single combination of unique_fields should correspond to a unique unique_fields_dim value

dims

A list of vectors. The first level should contain dimension names, and the second values for start, end, chunk_interval, overlap. All values should be integers, though start can be -Inf and end can be Inf

info_array

Does the entity have an info array? This will automatically cause entities named ⁠{entity_name}_INFO⁠, ⁠{entity_name}_METADATA_VALUE⁠, and ⁠{entity_name}_METADATA_ATTRKEY⁠ to be created if TRUE

info_array_attributes

Names of any attributes of the entity that should also appear in the info array

compression_on

Should the entity be compressed?

cached

Should the entity be cached? (Not supported yet)

keep_versions

The number of array versions to keep, including the latest (default only the latest). Set to NULL to keep all versions

yaml

The original yaml entry, which may contain package-specific values

Methods

Public methods

• RevealcoreArraySchema$new()

• RevealcoreArraySchema$clone()

---

Method new()

Usage

RevealcoreArraySchema$new(yaml)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RevealcoreArraySchema$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Paradigm4/revealcore documentation built on May 21, 2023, 9:57 a.m.