Core DevPre-alpha

How to extend a model with inherit=

Goal: add stored fields (and matching view xpath) to an existing ORM model from a dependent module without duplicating the base struct.

When to use

Your module depends on the module that owns the model (e.g. contacts depends on base for core.partner).
You need new columns on the same PostgreSQL table, not a separate model.

Steps

Add an extension struct in your addon models/ package:

```go title="models/partner_extend.go" copy lines

package models

import "sumeru/core/sdk"

type PartnerContacts struct {

sdk.Model sumeru:"inherit=core.partner"

CustomerRank sdk.Integer sumeru:"string=Customer Rank,default=0"

}

```

Use inherit= with the technical model name of the target. Do not set model= on the same struct — the tags are mutually exclusive.

Blank-import models from addon init.go if not already:

```go title="init.go" copy

import _ "sumeru/addons/contacts/models"

```

Run make generate (or make build) so models/zmodels.go calls sdk.MustRegister for the extension struct.

Update schema by installing or updating your module:

```bash shell copy

go run ./cmd/sumeru -- -c sumeru.conf -u contacts --stop-after-init

```

SyncRegistrySchemaForModule includes models extended by the module and runs additive DDL for new columns.

Expose fields in the UI with view xpath inherit (see View inherit xpath).

Go + XML together (contacts example)

models/partner_extend.go

1package models2 3import "sumeru/core/sdk"4 5type PartnerContacts struct {6	sdk.Model `sumeru:"inherit=core.partner"`7 8	CustomerRank sdk.Integer `sumeru:"string=Customer Rank,default=0"`9}

views/core_partner_form_inherit_views.xml

1<record id="view_core_partner_form_contacts_inherit" model="sys.view">2    <field name="inherit_id" ref="contacts.view_core_partner_form"/>3    <field name="arch" type="xml">4        <xpath expr="//field[@name='phone']" position="after">5            <field name="customer_rank" string="Customer Rank"/>6        </xpath>7    </field>8</record>

Rules and limits

The base model must register first (enforce with manifest.depends and correct addon import order).
Duplicate field names on the same model cause a startup panic with a clear error.
Go method override on models is not supported in v1 — use RegisterObjectAction or event.Subscribe for behavior.
Delegation inherit (parent table per record) is out of scope for this mechanism.

How to extend a model with inherit=

When to use

Steps

Go + XML together (contacts example)

Rules and limits

Live example

See also