View Source Appwrite.Types.Document (appwrite v0.2.1)

A document stored in an Appwrite Database collection.

System fields ($id, $collectionId, etc.) are mapped to their snake_case equivalents (:id, :collection_id, etc.).

The :data field carries all user-defined attributes returned by the API as a plain map().

Fields

  • id (String.t()) — document ID ($id).
  • collection_id (String.t()) — parent collection ID ($collectionId).
  • database_id (String.t()) — parent database ID ($databaseId).
  • created_at (String.t()) — creation timestamp in ISO 8601 ($createdAt).
  • updated_at (String.t()) — last-updated timestamp in ISO 8601 ($updatedAt).
  • permissions ([String.t()]) — Appwrite permission strings ($permissions).
  • data (map()) — user-defined attribute key-value pairs.

Summary

Types

t()

Types

t()

@type t() :: %Appwrite.Types.Document{
  collection_id: String.t(),
  created_at: String.t(),
  data: map(),
  database_id: String.t(),
  id: String.t(),
  permissions: [String.t()],
  updated_at: String.t()
}