PHPackages                             phillarmonic/syncopate-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. phillarmonic/syncopate-bundle

ActiveSymfony-bundle[Database & ORM](/categories/database)

phillarmonic/syncopate-bundle
=============================

Symfony bundle for integrating with SyncopateDB

1.6.0(1y ago)483MITPHPPHP >=8.1

Since Apr 29Pushed 1y ago1 watchersCompare

[ Source](https://github.com/Phillarmonic/syncopate-bundle)[ Packagist](https://packagist.org/packages/phillarmonic/syncopate-bundle)[ RSS](/packages/phillarmonic-syncopate-bundle/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (9)Versions (12)Used By (0)

SyncopateBundle
===============

[](#syncopatebundle)

A Symfony bundle for integrating with SyncopateDB, a flexible, lightweight data store with advanced query capabilities.

Compatibility between the bundle and SyncopateDB
------------------------------------------------

[](#compatibility-between-the-bundle-and-syncopatedb)

Syncopate Bundle VersionsSyncopateDB Server VersionsState1.x0.xActive development2.x (planned)1.x (planned)Planned future versionInstallation
------------

[](#installation)

### Step 1: Install the Bundle

[](#step-1-install-the-bundle)

```
composer require phillarmonic/syncopate-bundle
```

### Step 2: Enable the Bundle

[](#step-2-enable-the-bundle)

If you're using Symfony Flex, the bundle will be enabled automatically. Otherwise, add it to your `config/bundles.php`:

```
return [
    // ...
    Phillarmonic\SyncopateBundle\PhillarmonicSyncopateBundle::class => ['all' => true],
];
```

### Step 3: Configure the Bundle

[](#step-3-configure-the-bundle)

Create a configuration file at `config/packages/phillarmonic_syncopate.yaml`:

```
phillarmonic_syncopate:
    # Required: set the base URL of your SyncopateDB instance
    base_url: 'http://localhost:8080'

    # Optional configurations with defaults
    timeout: 30
    retry_failed: false
    max_retries: 3
    retry_delay: 1000

    # Entity discovery
    entity_paths:
        - '%kernel.project_dir%/src/Entity'
    auto_create_entity_types: true

    # Caching
    cache_entity_types: true
    cache_ttl: 3600
```

Usage
-----

[](#usage)

### Defining Entities

[](#defining-entities)

Define your entities using PHP 8 attributes:

```