Core Concepts

Learn the fundamental concepts of Codeless Sync and how it manages your data synchronization.

Overview

Codeless Sync is built around four main concepts:

1. Projects - Your PostgreSQL database connections
2. Configurations - Sync rules defining what and how to sync
3. Syncing - The process of transferring data
4. Schedules - Automated sync timing (Premium feature)

The Codeless Sync (CLS) Workflow

Connect Database → Create Configuration → Manual/Scheduled Sync → Data Updated

1. Connect Your Services

First, you connect your PostgreSQL database and API provider account. CLS securely stores your credentials and uses them to access both services.

2. Configure Syncs

A configuration defines:

• Which provider (Stripe, Shopify, PayPal, etc.)
• What data type (customers, invoices, etc.)
• Which database project and table
• Which fields to sync

3. Execute Syncs

Syncs can be triggered:

• Manually - Click "Sync Now" anytime (Free & Premium)
• Scheduled - Automatic scheduled syncs (Premium plans only)

4. Monitor Progress

CLS provides sync progress monitoring with:

• Batch-level updates
• Record counts
• Error handling
• Complete sync history

Key Terminology

Project

A PostgreSQL database connection containing your connection string. You can have multiple projects for different environments (Supabase, Neon, or other providers).

Need help getting your credentials? See our Database Setup Guide

Learn more: Projects Guide

Configuration

A sync rule connecting an API provider data type to a database table. Configurations are the core of CLS - they define what gets synced and where.

Learn more: Configurations Guide

Sync Run

A single execution of a configuration. Each sync has a unique ID, status, and detailed logs showing exactly what happened.

Learn more: Syncing Guide

Schedule

An automated trigger for a configuration. Schedules run syncs at specified intervals without manual intervention (Premium feature).

Learn more: Schedules Guide

Data Flow

Here's how data moves from your provider to your database:

1. Fetch - CLS requests data from your provider's API
2. Transform - Data is formatted for your database schema
3. Batch - Records are grouped for efficient processing
4. Upsert - Data is inserted or updated in your database
5. Log - Sync details are recorded for auditing

Active Status System

CLS uses a three-tier active status system:

• Project Active - Project must be active to use
• Configuration Active - Config must be active to sync
• Schedule Active - Schedule must be active to run automatically

Next Steps

Dive deeper into each concept:

• Projects - Managing database connections
• Configurations - Creating sync rules
• Syncing - How data synchronization works
• Schedules - Automating your syncs