note

VeloxDB is still in beta and APIs are subject to change. We are in the process of completing the documentation, so some sections may be incomplete or empty at this time.

VeloxDB API Documentation

This section of the site contains documentation for all APIs available in VeloxDB.

To get started, here are some of the most commonly used classes and their functions:

• DatabaseObject: The base class for all database objects.
• ObjectModel: The primary interface for interacting with the database. Provides methods for creating and retrieving objects, as well as executing queries.
• DatabaseClassAttribute: Attribute applied to classes to mark them as database classes.
• DatabasePropertyAttribute: Attribute applied to properties to mark them as database properties.
• DatabaseReferenceAttribute: Attribute applied to properties to mark them as references to other objects.

This section serves as an API reference. For a comprehensive guide on using these APIs and other features of VeloxDB, please see our Definitive Guide.