Reference Overview#

Palmyra’s public surface has four groups.

Annotations#

Schema mapping, routing, and permissions — see the Annotations section.

• Type mapping — @PalmyraType, @PalmyraMappingConfig, @PalmyraUniqueKey, @PalmyraForeignKey
• Field mapping — @PalmyraField, @PalmyraIgnore, @FetchConfig
• Routing — @CrudMapping, @ActionMapping
• Security — @Permission

Handler Interfaces#

Read-side

• QueryHandler — paged, filtered reads
• ReadHandler — criteria-based reads
• NativeQueryHandler — hand-written SQL
• TypedQueryHandler — type-safe row callback

Write-side

• CreateHandler
• UpdateHandler
• SaveHandler — upsert
• DeleteHandler

Export

• CsvHandler
• ExcelHandler
• CustomFormatHandler

Composite

• DataHandler — read + write (no delete)
• CrudHandler — full CRUD

Mixins

• PreProcessor — validate + ACL

File transfer

• TusUploadHandler
• TusDownloadHandler

Base Classes#

Core types used across every handler lifecycle — see the Base Classes section for per-class pages: Tuple, HandlerContext, FilterCriteria, QueryFilter, NativeQuery, ColumnMeta, PalmyraResponse, AuthProvider.

Query & Mutation Services#

• TupleQueryService — read operations
• TupleMutationService — write operations
• NativeQueryService — direct SQL

Platform Features#

• Password management
• ACL (access control list) management