Overview | SurrealDB

Surqlize is an object-relational mapper for SurrealDB in PHP, built on version 2 of the SDK, with attribute-driven models, a typed query builder, graph relations, and schema tooling.

Surqlize is an object-relational mapper for SurrealDB in PHP. You describe tables as PHP classes with attributes, then compose SurrealQL through a typed query builder instead of writing strings. It is built on top of version 2 of the SDK and uses the SDK to execute queries.

The core idea is small: describe your SurrealDB tables with models and attributes, then build queries through typed PHP APIs that your IDE and static analyser understand. Surqlize compiles each query to a deterministic SurrealQL string for tests, and runs it through the SDK with parameter-bound values at runtime.

Important

Surqlize is published as 0.0.1-alpha.2 and is in early development. It requires PHP 8.4 and depends on the alpha v2 SDK, so its API may change.

Getting started

Installation

Install Surqlize with Composer and the alpha SDK it depends on.

Models

Describe tables as PHP classes with attribute-driven fields.

Connections

Building queries

Querying

Typed select, where, ordering, projections, and the execution methods.

Mutations

Create, update, upsert, and delete with model helpers and builders.

Edges and graph

Edge models, graph traversal, and RELATE.

Search, vector, and geometry

Full-text search, vector KNN, and geometry helpers.

Schema and tooling

Schema

Define tables with a schema contract or the fluent DSL.

Code generation and CLI

Generate typed field adapters and run the CLI commands.

Transactions

Batch ORM queries into a single transaction with rollback.

Sources

GitHub repository
PHP SDK v2 that Surqlize builds on
Laravel integration for using Surqlize in Laravel