Core Documentation

Maryk’s core module defines the data contract: models, properties, keys, queries, serialization and version-aware behavior.

Recommended order for new users:

1. Data Design
2. Data Models
3. Properties
4. Keys
5. Querying Data
6. Versioning
7. Serialization

Contents

• Data Design: choose embedding, references, keys, indexes and graphs.
• Data Models: define model structures and property indexes.
  • Properties: overview of property types, validations, operations and references.
  • Keys: design unique and efficient keys for data objects.
  • Index Design: choose between ordered, normalized, and search-oriented indexes.
• Versioning: track and request historical value versions.
• Querying Data: typed reads and writes, atomic change sets and serializable transactions.
  • Reading and writing: CRUD requests and paging.
  • History: field changes and bounded revision pages.
  • Sync and live views: update streams and replication.
  • Choosing a write boundary: initial-state write sets versus ordered read/write scopes.
  • Reference Graphs: select specific properties to return.
  • Filters: filter operators for narrowing query results.
  • Aggregations: aggregate data with value and bucket operators.
• Collect & Inject: reuse values from previous responses in new requests.
• Serialization: write and read YAML, JSON or ProtoBuf.
  • ProtoBuf Transport: details on ProtoBuf wire formats.

Properties Subfolder

The properties directory dives deeper into property concepts:

• README.md – overview of property characteristics and validation
• operations.md – property operations such as change or delete
• references.md – creating references to properties
• types/ – documentation of each property type