A python SDL generator based on pydantic

[nathanschwarz]

Hey there community !

I've developed a small python module to generate SURQL SDL strings.
The module is based on pydantic and is very simple to use.

✅ it supports the following features

• collection definitions (a.k.a tables)
  • schemafull / schemaless
  • drop
  • changefeed
  • view
  • indexes definitions
    • regular indexes
    • unique indexes
    • search indexes
  • fields and tables permissions
• analyzers definition
• tokenizers definition
• events definition

and the following types out of the box :

• basic types (string | int | float | boolean | datetime | any, enum)
• union
• optional and null
• array
• set
• object
• record

❌ what it doesn't support yet :

• Future types
• Geometry types
• SURQL queries definitions (select, update, delete, where, ...)
• SURQL functions definitions
• SURQL scopes definitions
• SURQL SDL field validation (validation goes through pydantic, too complex at this stage)
• namespaces definitions
• databases definitions
• users definitions
• tokens definitions
• params definitions

PRs are welcome 😉

installation

To install pydantic-surql run :

pip install pydantic-surql

or with poetry :

poetry add pydantic-surql

basic usage

to convert a pydantic model to a surql SDL definition you can use a simple decorator :

from datetime import datetime
from typing import Optional
from pydantic import BaseModel
from pydantic_surql import surql_collection

@surql_collection("writers")
class Writer(BaseModel):
    id: str
    firstname: str
    lastname: str
    birthdate: datetime


@surql_collection("books")
class Book(BaseModel):
    id: str
    title: str
    pages: Optional[int]
    description: str
    weight: float
    writer: Writer

All the models decorated with @surql_collection will be collected by the Metadata object, which will be used to generate the SDL.

To generate the SDL :

from pydantic_surql import Metadata
models_sdl: str = Metadata.collect()

this will generate the following SDL :

DEFINE TABLE writers SCHEMAFULL;
DEFINE FIELD firstname ON TABLE writers TYPE string;
DEFINE FIELD lastname ON TABLE writers TYPE string;
DEFINE FIELD birthdate ON TABLE writers TYPE datetime;

DEFINE TABLE books SCHEMAFULL;
DEFINE FIELD title ON TABLE books TYPE string;
DEFINE FIELD pages ON TABLE books TYPE optional<number>;
DEFINE FIELD description ON TABLE books TYPE string;
DEFINE FIELD weight ON TABLE books TYPE number;
DEFINE FIELD writer ON TABLE books TYPE record<writers>;

You can check more on :

• the repository here
• the pypi module here