Library Reference
Complete reference documentation for InstantObjects units and classes.
Overview
InstantObjects is organized into several functional areas, each containing related units and classes. This reference provides detailed documentation for all public classes, methods, properties, and events.
Core Units
The foundation of InstantObjects - essential units for object persistence and metadata management.
| Unit | Description |
|---|---|
| InstantPersistence | Core persistence classes: TInstantObject, attributes, connectors |
| InstantBrokers | Broker architecture: SQL and navigational brokers |
| InstantMetadata | Metadata system for object-to-database mapping |
| InstantTypes | Type definitions, enumerations, and base types |
| InstantClasses | Base infrastructure classes and utilities |
| InstantCommand | Command and query execution |
Presentation Units
Data-aware components for user interface integration.
| Unit | Description |
|---|---|
| InstantPresentation | TInstantExposer and TInstantSelector components |
Database Units
Database building, evolution, and schema management.
| Unit | Description |
|---|---|
| InstantDBBuild | Database builder for creating schema from model |
| InstantDBEvolution | Database evolution for schema updates |
Broker Units
Database-specific broker implementations.
File-Based Brokers
| Unit | Description |
|---|---|
| InstantXML | XML file-based storage broker |
| InstantJSON | JSON file-based storage broker |
SQL-Based Brokers
| Unit | Description |
|---|---|
| InstantFireDAC | Universal FireDAC broker (recommended) |
| InstantIBX | InterBase/Firebird IBX broker |
| InstantADO | ADO broker for MS SQL Server and Access |
| InstantDBX | dbExpress broker for multiple databases |
REST and JSON Units
Modern REST API and JSON serialization support.
| Unit | Description |
|---|---|
| Instant.Neon.Serializers | Neon-based JSON serialization |
| InstantObjects.MARS.Server | MARS Curiosity REST server integration |
| InstantObjects.WiRL.Server | WiRL REST server integration |
Quick Navigation
By Task
Working with Objects:
- Creating and storing objects → InstantPersistence
- Retrieving objects → InstantPersistence
- Querying objects → InstantCommand
User Interface:
- Displaying single object → InstantPresentation (TInstantExposer)
- Displaying object collections → InstantPresentation (TInstantSelector)
Database:
- Creating database schema → InstantDBBuild
- Updating database schema → InstantDBEvolution
- Choosing a broker → InstantBrokers
REST APIs:
- JSON serialization → Instant.Neon.Serializers
- Building MARS REST API → InstantObjects.MARS.Server
- Building WiRL REST API → InstantObjects.WiRL.Server
By Class
Common classes quick reference:
TInstantObject→ InstantPersistenceTInstantConnector→ InstantPersistenceTInstantExposer→ InstantPresentationTInstantSelector→ InstantPresentationTInstantQuery→ InstantCommandTInstantBroker→ InstantBrokersTInstantDBBuilder→ InstantDBBuild
Conventions
Throughout this reference:
- Class names are shown in
monospacefont - Required parameters are shown in bold
- Optional parameters are shown in italic
- Deprecated items are clearly marked
- Version information indicates when features were introduced
See Also
- User Guide - Step-by-step tutorials
- Primer Demo - Working examples
- Advanced Features - JSON, REST, and more
