23 docs tagged with "Data Access"

Association Roles define the relationship types between entities. Each role specifies the multiplicity and naming for both directions of the relationship (inbound and outbound).

Associations define relationships between entities in the runtime model. This chapter describes how to query and navigate associations.

Attributes are reusable property definitions that can be applied to types. Each attribute has a value type and optional constraints.

This chapter provides best practices for writing efficient and maintainable GraphQL queries and mutations.

The Construction Kit defines the schema and structure of your data model. Unlike the Runtime Model which stores actual data instances, the Construction Kit contains the metadata that defines what types of entities can exist, their attributes, relationships, and constraints.

GraphQL allows to query and mutate data. Mutations are operations like create, update and delete. This chapter describes how data can be created.

GraphQL allows to query and mutate data. Mutations are operations like create, update and delete. This chapter describes how data can be deleted.

Enums define a fixed set of allowed values for an attribute. Each enum value has a numeric key, a name, and an optional description.

This chapter describes how errors are returned in GraphQL responses and how to handle them.

Models are containers that group related types, attributes, enums, and records. Each model has a name, version, and can depend on other models.

In OctoMesh, we understand that data is at the heart of your operations. This chapter focuses on how you can access and interact with your data through our Construction Kits (CK), tailored for both runtime data and stream (time series) data. Leveraging GraphQL endpoints, OctoMesh offers a seamless and efficient way to work with your data, regardless of its nature.

Records are composite value types that group related attributes together. Unlike types, records are embedded directly within entities rather than being independent entities with their own runtime IDs.

This chapter describes common query patterns for retrieving Construction Kit metadata. The Construction Kit API is read-only - you query the model structure but cannot modify it through GraphQL.

Simple query

GraphQL allows to query and mutate data. Mutations are operations like create, update and delete. This chapter describes how data can be created, retrieved, updated and deleted. It provides a reference for the GraphQL scalar types, input types, and enums used in the OctoMesh GraphQL API.

The SearchFilter provides text search capabilities across multiple attributes of an entity. It is optimized for text-based searches and is typically used for search fields in list views.

The area `streamData` allows access to stored time series data. Let's start with simple sample that requests the voltage value of all energy meters by their timestamp.

This chapter describes how to create System Queries. For an overview of System Queries and their use cases, see System Queries.

System Queries are reusable query configurations stored in the repository. They allow you to define a query once and execute it from multiple places using only its ID.

This chapter describes how to update System Queries. For an overview of System Queries and their use cases, see System Queries.

Transient queries allow you to dynamically query runtime entities with configurable column paths. Unlike regular queries where the returned fields are defined in the GraphQL query itself, transient queries return data in a table-like structure with rows and cells.

Types define the structure of entities in the Runtime Model. Each type has attributes, can inherit from a base type, and can participate in associations with other types.

GraphQL allows to query and mutate data. Mutations are operations like create, update and delete. This chapter describes how data can be updated.