Odoo Sparse Field - Trường dữ liệu linh hoạt

Thuật ngữ cơ bản

Các bước thực hiện

• 1. Tạo một trường Text hoặc Serialized làm JSON storage column

• 2. Định nghĩa các trường với thuộc tính sparse=<json_field_name>

• 3. Odoo tự động serialize/deserialize khi đọc/ghi dữ liệu

• 4. Các trường sparse hoạt động như trường thông thường trong code

• 5. Database chỉ lưu một cột JSON thay vì nhiều cột riêng lẻ

Các bước thực hiện

• 1. x_custom_data = fields.Serialized(string="Custom Data Storage")

• 2. x_field1 = fields.Char(string="Field 1", sparse="x_custom_data")

• 3. x_field2 = fields.Integer(string="Field 2", sparse="x_custom_data")

• 4. x_field3 = fields.Boolean(string="Field 3", sparse="x_custom_data")

• 5. Tất cả x_field1, x_field2, x_field3 được lưu trong x_custom_data

Điểm chính

• • Giảm số lượng cột trong database, tránh vượt quá giới hạn cột của PostgreSQL

• • Linh hoạt thêm trường mới mà không cần ALTER TABLE

• • Tối ưu cho các trường ít được sử dụng (sparse usage)

• • Dễ dàng mở rộng schema mà không ảnh hưởng cấu trúc database

• • Giảm overhead khi có nhiều trường NULL

• • Hỗ trợ migration và upgrade dễ dàng hơn

• • Phù hợp cho custom fields và dynamic attributes

Điểm chính

• • Không thể tạo index trực tiếp trên sparse field

• • Không hỗ trợ database constraints (unique, foreign key)

• • Hiệu suất truy vấn chậm hơn so với cột thông thường

• • Không thể sử dụng trong domain search phức tạp

• • Khó debug và monitor dữ liệu trong database

• • Không phù hợp cho trường được truy vấn thường xuyên

• • Tăng kích thước dữ liệu do JSON overhead

Điểm chính

• • Custom fields do người dùng tự định nghĩa

• • Thuộc tính sản phẩm động (product attributes)

• • Metadata và configuration settings

• • Trường chỉ áp dụng cho một số loại record nhất định

• • Temporary fields cho migration hoặc testing

• • Extension fields cho third-party modules

• • Trường có tần suất sử dụng thấp

Các bước thực hiện

• 1. Tạo model hoặc inherit model hiện có

• 2. Định nghĩa trường Serialized làm JSON storage

• 3. Thêm các trường với thuộc tính sparse=<storage_field>

• 4. Cấu hình form view để hiển thị các trường

• 5. Test đọc/ghi dữ liệu để đảm bảo hoạt động đúng

• 6. Monitor performance nếu có nhiều sparse fields

Các bước thực hiện

• 1. custom_attrs = fields.Serialized("Custom Attributes")

• 2. color = fields.Char("Color", sparse="custom_attrs")

• 3. size = fields.Char("Size", sparse="custom_attrs")

• 4. material = fields.Char("Material", sparse="custom_attrs")

• 5. weight = fields.Float("Weight", sparse="custom_attrs")

• 6. Tất cả thuộc tính lưu trong một JSON column

Các bước thực hiện

• 1. preferences = fields.Serialized("User Preferences")

• 2. theme = fields.Selection([...], sparse="preferences")

• 3. language = fields.Char(sparse="preferences")

• 4. timezone = fields.Char(sparse="preferences")

• 5. notifications = fields.Boolean(sparse="preferences")

• 6. Mỗi user có preferences riêng trong JSON

Các bước thực hiện

• 1. config_data = fields.Serialized("Configuration")

• 2. api_key = fields.Char(sparse="config_data")

• 3. api_endpoint = fields.Char(sparse="config_data")

• 4. timeout = fields.Integer(sparse="config_data")

• 5. retry_count = fields.Integer(sparse="config_data")

• 6. Dễ dàng thêm config mới mà không alter table

Điểm chính

• • Giới hạn số lượng sparse fields trong một JSON column

• • Tránh lưu dữ liệu lớn (binary, text dài) trong sparse field

• • Sử dụng cột thông thường cho trường được query thường xuyên

• • Cache dữ liệu sparse field ở application layer

• • Định kỳ cleanup và optimize JSON data

• • Monitor kích thước JSON column để tránh bloat

• • Sử dụng computed fields thay vì sparse cho calculated values

Các bước thực hiện

• 1. Có thể sử dụng domain search như trường thông thường

• 2. Ví dụ: [("color", "=", "red")] với color là sparse field

• 3. Odoo tự động deserialize JSON để so sánh

• 4. Performance chậm hơn so với indexed column

• 5. Tránh sử dụng trong query phức tạp hoặc large dataset

• 6. Cân nhắc denormalize nếu cần query performance cao

Điểm chính

• • Thêm trường mới không cần migration script

• • Xóa trường chỉ cần remove field definition

• • Đổi tên trường cần migration để update JSON keys

• • Thay đổi field type cần careful migration

• • Backup JSON data trước khi migration lớn

• • Sử dụng default values cho backward compatibility

• • Test migration trên staging environment trước

Điểm chính

• • Field-level security áp dụng cho từng sparse field

• • Record rules hoạt động bình thường với sparse fields

• • Có thể ẩn sparse field khỏi user groups nhất định

• • Encrypt sensitive data trước khi lưu vào JSON

• • Audit log changes cho critical sparse fields

• • Validate input data để tránh JSON injection

Các bước thực hiện

• 1. Bật developer mode để xem raw JSON data

• 2. Sử dụng psql để query JSON column trực tiếp

• 3. Log serialization/deserialization errors

• 4. Validate JSON structure với schema

• 5. Check for data corruption trong JSON

• 6. Monitor JSON column size growth

• 7. Use pgAdmin hoặc DBeaver để inspect JSON data

Điểm chính

• • Chỉ sử dụng sparse field cho trường ít được query

• • Đặt tên JSON storage field rõ ràng (vd: x_custom_data)

• • Document các sparse fields trong module description

• • Giới hạn 10-15 sparse fields per JSON column

• • Sử dụng meaningful field names cho sparse fields

• • Implement validation cho sparse field values

• • Backup database trước khi thay đổi sparse field structure

• • Monitor performance impact khi thêm sparse fields

So sánh Sparse Field vs Regular Field

Điểm chính

• • Trường được query thường xuyên trong reports

• • Trường cần index để tối ưu performance

• • Trường cần database constraints (unique, foreign key)

• • Trường chứa dữ liệu critical cần high integrity

• • Trường được sử dụng trong complex joins

• • Trường cần full-text search

• • Khi performance là ưu tiên hàng đầu

Các bước thực hiện

• 1. Override _get_sparse_data() method

• 2. Override _set_sparse_data() method

• 3. Implement custom JSON encoder/decoder

• 4. Handle special data types (datetime, binary)

• 5. Add compression cho large JSON data

• 6. Implement versioning cho JSON schema

Điểm chính

• • Monitor JSON column size trong database

• • Track serialization/deserialization performance

• • Audit unused sparse fields và cleanup

• • Vacuum database định kỳ để optimize storage

• • Log errors related to JSON parsing

• • Set up alerts cho JSON column size threshold

• • Review và optimize JSON structure định kỳ

Các bước thực hiện

• 1. Technical Features: Quyền truy cập developer mode

• 2. Model access rights: Quyền read/write trên model

• 3. Field-level security: Quyền truy cập từng sparse field

• 4. Database access: Để inspect JSON data (optional)