Skip to main content

A marshmallow-sqlalchemy field allows referential CRUD on relational fields.

Project description


pip install marshmallow-sqlalchemy-referential

Sample Usage

import sqlalchemy as sa
from sqlalchemy.ext.declarative import declarative_base
from marshmallow_sqlalchemy_referential import Referential
from marshmallow_sqlalchemy import ModelSchema
from marshmallow import fields

Base = declarative_base()

user_group_assoc = sa.Table(
  'user_group_assoc', Base.metadata,
  sa.Column('user_id', sa.Integer, sa.ForeignKey('')),
  sa.Column('group_id', sa.Integer, sa.ForeignKey(''))

class User(Base):
    __tablename__ = 'user'

    id = sa.Column(sa.Integer(), primary_key=True)
    groups = sa.orm.relationship('Group', secondary=user_group_assoc)

class Group(Base):
    __tablename__ = 'group'

    id = sa.Column(sa.Integer(), primary_key=True)
    users = sa.orm.relationship('User', secondary=user_group_assoc)

class GroupSchema(ModelSchema):
  class Meta():
      dump_only = ['id']

  id = fields.Integer()

class UserSchema(ModelSchema):
  class Meta():
      dump_only = ['id']

  id = fields.Integer()
  groups = Referential(GroupSchema, model=Group, many=True)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page