Vercel Logo
DOCS
TECHNICAL DOCS
SYNC DEFINITIONS

Syncraft and Sync Definitions

Overview:

Syncraft is our proprietary framework designed to seamlessly interface with multiple data sources, from traditional databases like SQL and NoSQL to more specialized interfaces such as blockchains or HTTP services. At its core, Syncraft provides a unified querying layer to interact with these sources through a standardized set of operations, ensuring consistency and efficiency.

Components:

  • Name: Every data source will have a unique identifier. This helps in distinguishing the source type and defining its behavior.

  • dataTypeFormatter: This component takes care of any unique peculiarities in the way data types are represented or processed in a specific data source.

  • availableDataTypes: Lists the data types that the particular data source supports. While there might be overlaps, each data source may have its unique types or variations.

  • queryFormatter: This crucial component outlines how a general query gets translated into something the data source can understand. Due to the vast differences in data sources, this part might be simple for some (like HTTP requests) but more intricate for others (like databases).

  • Operators: These are the building blocks of queries. Even though operations like 'equal to', 'less than', or 'contains' might seem universal, how they're implemented can vary dramatically between data sources. The QL definition provides a mapping mechanism that transforms high-level operations into their specific counterparts for each data source.

  • Joins: While not all data sources will support this (e.g., HTTP services), many databases or data-related interfaces do. This defines how data from different sections or sources can be combined based on common criteria.

Approach:

For every data source Syncraft interfaces with, there's a QL definition that details its behavior. This definition acts as a bridge, translating Syncraft's high-level operations into commands or queries that the data source can understand and execute. The richness and depth of each definition will often mirror the complexity and capability of the data source itself.

The Bigger Picture:

While we've covered the basics here, remember that the beauty of Syncraft lies in its adaptability. As we incorporate more data sources - be it OpenSearch, Redis, blockchains, or even things we haven't yet imagined - Syncraft's architecture allows for scaling and adaptation. Every new data source gets its QL definition, ensuring that Syncraft remains a consistent and powerful interface, regardless of the backend diversity.

Learn More
Developer Guideline
Continue Your Journey
Adapters