Skip to main content

Module meta_adapter

Module meta_adapter 

Source
Expand description

Adapter that manages metadata. Everything including tenants, profiles, actions, file metadata, etc.

Structs§

Action
ActionData
Additional action data (cached counts/stats)
ActionView
AddressBook
Address book collection metadata
AttachmentView
Calendar
Calendar collection metadata. Parallels AddressBook.
CalendarObject
Full calendar object row including the authoritative stored VCALENDAR blob.
CalendarObjectExtracted
Indexed projection of a calendar object — lives in DB columns alongside the authoritative iCalendar blob. Enables calendar-query time-range filtering and REST search.
CalendarObjectSyncEntry
One entry in a CalDAV sync-collection REPORT response. Tombstones (deleted: true) let clients drop stale objects.
CalendarObjectView
Calendar object summary without the iCalendar blob — for list endpoints.
CalendarObjectWrite
Borrowed write payload for calendar-object upserts. Groups the four fields that always travel together (authoritative blob + its derived etag + indexed projection) so trait methods writing multiple objects in one tx don’t accumulate parallel-scalar parameter lists.
Contact
Full contact row including the authoritative stored vCard blob.
ContactExtracted
Indexed projection of a contact — lives in DB columns, parallel to the stored vCard blob. Used both for REST API responses (via the handler layer’s JSON conversion) and for CardDAV addressbook-query REPORT text-match filtering.
ContactSyncEntry
One entry in a CardDAV sync-collection REPORT response. Tombstones (deleted: true) let clients drop stale cards.
ContactView
Contact summary without the vCard blob — for list endpoints (REST + CardDAV REPORTs that don’t need the full body).
CreateCalendarData
CreateFile
CreateFileVariant
CreateRefOptions
CreateShareEntry
DeleteFileResult
What MetaAdapter::delete_file removed.
DocFormat
Document format manifest — how an app declares what it indexes.
FileUserData
User-specific file metadata (access tracking, pinned/starred status)
FileVariant
FileView
FinalizeActionOptions
Options for finalizing an action (resolved fields from ActionCreatorTask)
InstallApp
Data for installing an app
InstalledApp
Installed app record
ListActionOptions
Options for listing actions
ListCalendarObjectOptions
ListContactOptions
ListFileOptions
Options for listing files
ListProfileOptions
ListRefsOptions
ListTaskOptions
ListTenantsMetaOptions
Options for listing tenants in meta adapter
PathSegment
Single hop in a file’s folder ancestry chain.
Profile
ProfileData
Profile data returned from adapter queries
ProfileInfo
ProfileList
List of profiles response
PublicProfileRow
Reduced, public-safe profile projection returned by MetaAdapter::read_profiles. Deliberately not Profile, which carries the reading tenant’s private relationship state — status (including Blocked/Muted/Banned), connected/following/follower, trust and the feed/msg read watermarks. None of that may reach a batch caller.
PushSubscription
Full push subscription record stored in database
PushSubscriptionData
Web Push subscription data (RFC 8030)
PushSubscriptionKeys
Subscription keys for Web Push encryption
RefData
SearchMatch
A highlighted range inside a snippet.
SearchObject
The object a set of SearchParts belongs to. The ACL columns are denormalised mirrors of the source row so the search query can pre-filter in SQL.
SearchOptions
Search query options. The fields below the marker are server-derived and are never deserialized from the wire.
SearchPart
One indexable unit of an object.
SearchRow
A single search index row plus its FTS ranking data.
ShareEntry
SpaceReport
What MetaAdapter::reclaim_space found, and whether it acted on it.
Task
TaskPatch
Tenant
TenantListMeta
Tenant list item from meta adapter (without cover_pic and x fields)
UpdateActionDataOptions
Options for updating action metadata
UpdateAddressBookData
UpdateCalendarData
UpdateFileOptions
Options for updating file metadata
UpdateProfileData
UpdateRefOptions
Options for updating an existing reference via PATCH semantics.
UpdateShareEntryOptions
Options for updating an existing share entry via PATCH semantics.
UpdateTenantData
UpsertDocFormat
Writable subset of DocFormat.
UpsertProfileFields
Fields for MetaAdapter::upsert_profile.

Enums§

ActionCountGroupBy
Field to group an action count by. Mapped to a fixed column server-side (never interpolated from caller input) to keep the query injection-safe.
ActionId
AudienceType
Audience filter axis: classify actions by the type of the effective wall owner (coalesce(audience, issuer_tag) joined to profiles.type). Personal matches pa.type='P' (with NULL→Personal fallback for unknown remote profiles). Community matches pa.type='C'. Combines with audience (specific community) as AND.
BrokenReason
Reason a cross-context file row is tombstoned. Written by the refresh endpoint based on the source’s response. Tombstones are sticky, so this is reserved for permanent / authoritative source signals — transient network failures DO NOT mutate the row (the handler surfaces them out-of-band via refreshStatus in the response wrapper).
FileId
FileStatus
File status enum Note: Mutability is determined by fileTp (BLOB=immutable, CRDT/RTDB=mutable)
ProfileConnectionStatus
ProfileStatus
ProfileTrust
Per-profile proxy-token preference for passive reads of a remote profile’s content. Absent (NULL) means ask the user at the time of access.
ProfileType
UpsertResult
Outcome of an upsert_profile call.

Constants§

IDP_ACTIVATION_REF_TYPE
Activates an identity at the IdP — power over the tenant account, not over its membership.
MANAGED_PARENT_ID
Special parent_id value for system-managed files (action attachments, profile/cover images, cached remote profile images). Files in this hidden per-tenant folder are reaped by the file GC when no canonical column still references them.
PASSWORD_REF_TYPE
Password-reset capability against one tenant account.
PROFILE_INVITE_REF_TYPE
Buys membership of one community — the tenant’s leadership legitimately hands these out.
REGISTER_REF_TYPE
Grants the right to create a NEW TENANT on this server — server-scoped, so SADM only.
ROOT_PARENT_ID
Sentinel parent_id value representing the root (files with no parent folder). API input/filter only — never appears in DB rows; root rows have parent_id = NULL in the files table. Use this constant only on the API surface when the request needs to disambiguate root from “no filter”.
SEARCH_MAX_CONTENT_TYPES
SEARCH_MAX_LIMIT
Bounds a SearchOptions is clamped to at both ends — the handler clamps what a caller asked for, the adapter re-clamps what it was handed — so a programmatic caller cannot widen them either. Deep offsets in a relevance-ordered FTS scan get expensive fast.
SEARCH_MAX_OFFSET
SEARCH_MAX_TAGS
Bounds on the two list-valued filters, clamped at both ends the same way: ~33k contentType values overrun SQLite’s 32766 bound-variable limit into a 500, and a long tags list builds an arbitrarily deep FTS5 MATCH expression.
SHARE_FILE_REF_TYPE
The one ref type an ordinary member may mint, list or revoke: a file share link.
TRASH_PARENT_ID
Special parent_id value for trashed files
WELCOME_REF_TYPE
First-login capability; POST /api/auth/set-password accepts it exactly like password.

Traits§

MetaAdapter