Skip to content

MJCZone.DapperMatic.AspNetCore.Models ​

Assembly: MJCZone.DapperMatic.AspNetCore

Classes ​

NameDescription
DapperMaticAccessDocumentPolicies and tenants, as they are kept, exported and imported.
DapperMaticApiKeyAn API key, as DapperMatic keeps it: its secret only as a hash (the key itself is shown once, when made).
DapperMaticCachedTableA table or view whose query results are kept, for at most Duration. A write made through DapperMatic (its row and batch endpoints, or <c>DapperMaticCallerDb</c>) makes them stale at once; a write made elsewhere is seen when the duration runs out, or at once after <c>DapperMaticResultCache.InvalidateAsync</c>.
DapperMaticConnectionPolicyWhat a datasource added or changed through the API may connect to. A connection string is code that runs on the server: it can name any host, ask the driver to read local files, or point SQLite at any path. Datasources from code or configuration are trusted and not checked.
DapperMaticEffectiveAccessWhat the policies let the caller do to a datasource, schema, table or view.
DapperMaticEffectiveActionWhat the policies let the caller do for one action. The conditions and the policies' names are shown to a caller who may manage access to the resource.
DapperMaticFunctionA function callers may run through <c>POST /d/{datasourceId}/f/{name}</c>, with the Execute action: SQL the application writes, or a routine of the database. Nothing is callable unless declared here; the SQL is the application's, and is never assembled from the request.
DapperMaticFunctionParameterA parameter of a DapperMaticFunction.
DapperMaticKeyFilterWhich keys a listing is of.
DapperMaticQueryLimitsHow much a query request may ask for; a request that asks for more is refused with 400.
DapperMaticRealtimeOptionsHow subscriptions are kept current.
DapperMaticRealtimeTableA table or view whose queries callers may subscribe to (<c>GET …/subscribe</c>): its changes made through DapperMatic are noted in the datasource, and each subscription's query is run again when a table it reads changes.
DapperMaticRelationA relation query requests may follow from a table: in conditions (<c>customer/country eq 'FR'</c>, <c>lines/any(l: l/qty gt 5)</c>), orderings and <c>$expand</c>. A request can follow only the relations declared: none is inferred from the database's foreign keys.
DapperMaticSearchableA table <c>$search</c> searches, and the columns it searches. Where the database has a full-text index of them, it is used: a PostgreSQL GIN or GiST index on <c>to_tsvector(...)</c> of the columns, a MySQL <c>FULLTEXT</c> index of exactly the columns, or a SQLite FTS5 table named <c>{table}_fts</c> whose rowids are the table's. Else every word must be contained, ignoring case, in one of the columns.
DapperMaticServiceAccountAn account for a program, not a person: an integration, a scheduled job, an AI assistant. It has its own name, roles, claims and tenant, and its keys sign in as it; policies treat it as any caller with those roles. It keeps working whoever comes and goes. Kept with the policies and tenants, or given in code or configuration.
DapperMaticSessionValueA value set on each connection's session for the database's own row-level security.
DapperMaticTenancyOptionsFinds the tenant a request acts for in it: its id, from a source; then what is known of the tenant, from configuration or code. Nothing is assumed about what a tenant is: a key on rows, a schema, a datasource, a node of a tree; set what applies.
DapperMaticTenantSettingsWhat is known of one tenant.
DapperMaticTenantSourceWhere a tenant's id is read from. Set one property.
DapperMaticValueSettingsA value: fixed, or read with SQL when first used. Set one of Value and Sql.
DapperMaticWebhookA web address told of the changes made through DapperMatic to the tables it names: each change is noted in the datasource, in the write's transaction, and sent from there in order, retried until the address takes it. A message names the table, the action and the keys of the rows, never other columns; it is signed with the secret (<c>X-DapperMatic-Signature: sha256=…</c>, an HMAC of <c>{timestamp}.{body}</c>).
DapperMaticWebhookOptionsHow webhooks' messages are sent.
DapperMaticWebhookStatusWhere a webhook's messages have got to in a datasource.

Enums ​

NameDescription
DapperMaticKeyKindWhom a key signs in as.
DapperMaticWebhookActionsWhat a webhook hears.