services
data_display
orm
Odoo 19 services — orm (core)
Live preview
Interactive
Source excerpt
web/static/src/core/orm_service.js
import { registry } from "@web/core/registry";
import { rpc } from "@web/core/network/rpc";
import { user } from "@web/core/user";
import { Domain } from "@web/core/domain";
/**
* This ORM service is the standard way to interact with the ORM in python from
* the javascript codebase.
*/
// -----------------------------------------------------------------------------
// ORM
// -----------------------------------------------------------------------------
/**
* One2many and Many2many fields expect a special command to manipulate the
* relation they implement.
*
* Internally, each command is a 3-elements tuple where the first element is a
* mandatory integer that identifies the command, the second element is either
* the related record id to apply the command on (commands update, delete,
* unlink and link) either 0 (commands create, clear and set), the third
* element is either the ``values`` to write on the record (commands create
* and update) either the new ``ids`` list of related records (command set),
* either 0 (commands delete, unlink, link, and clear).
*/
export const x2ManyCommands = {
// (0, virtualID | false, { values })
CREATE: 0,
create(virtualID, values) {
delete values.id;
return [x2ManyCommands.CREATE, virtualID || false, values];
},
// (1, id, { values })
UPDATE: 1,
update(id, values) {
delete values.id;
return [x2ManyCommands.UPDATE, id, values];
},
// (2, id[, _])
DELETE: 2,
delete(id) {
return [x2ManyCommands.DELETE, id, false];
},
// (3, id[, _]) removes relation, but not linked record itself
UNLINK: 3,
unlink(id) {
return [x2ManyCommands.UNLINK, id, false];
},
// (4, id[, _])
LINK: 4,
link(id) {
return [x2ManyCommands.LINK, id, false];
},
// (5[, _[, _]])
CLEAR: 5,
clear() {
return [x2ManyCommands.CLEAR, false, false];
},
// (6, _, ids) replaces all linked records with provided ids
SET: 6,
set(ids) {
return [x2ManyCommands.SET, false, ids];
},
};
function validateModel(value) {
if (typeof value !== "string" || value.length === 0) {
throw new Error(`Invalid model name: ${value}`);
}
}
function validatePrimitiveList(name, type, value) {
if (!Array.isArray(value) || value.some((val) => typeof val !== type)) {
throw new Error(`Invalid ${name} list: ${value}`);
}
}
function validateObject(name, obj) {
if (typeof obj !== "object" || obj === null || Array.isArray(obj)) {
throw new Error(`${name} should be an object`);
}
}
function validateArray(name, array) {
if (!Array.isArray(array)) {
throw new Error(`${name} should be an array`);
}
}
export const UPDATE_METHODS = [
"unlink",
"create",
"write",
"web_save",
"web_save_multi",
"action_archive",
"action_unarchive",
];
export class ORM {
constructor() {
this.rpc = rpc; // to be overridable by the SampleORM
/** @protected */
this._silent = false;
this._cache = false;
}
/** @returns {ORM} */
get silent() {
return Object.assign(Object.create(this), { _silent: true });
}
/**
* @param {object} options
* @returns {ORM}
*/
cache(options = {}) {
return Object.assign(Object.create(this), { _cache: options });
}
/**
* @param {string} model
Registry / API
- Registry name
orm- Category
services- Module
web- Slug
orm- Nav group
data_display