Instantané d’une Base
IBaseSnapshot
IBaseSnapshot est le format que Univer Bases écrit pour le stockage. Un instantané décrit une unité de base : ses tables et leur ordre, la version du schéma, les timestamps et les métadonnées de révision optionnelles.
Propriétés
| Propriété | Type | Description |
|---|---|---|
| id | string | Identifiant unique de l’unité Base. |
| name | string | Nom de la base. |
| schemaVersion | number | Version du schéma de l’instantané. |
| tables | Record\<string, ITableSnapshot\> | Tables indexées par identifiant de table. |
| tableOrder | string[] | Liste ordonnée des identifiants de tables. |
| createdAt | number | Horodatage de création. |
| updatedAt | number | Chronographe de la dernière mise à jour. |
| createdBy? | string | ID du créateur. |
| rev? | number | Valeur de révision optionnelle, utilisée par les couches de persistance ou de collaboration. |
Instantané minimal
const baseSnapshot = { id: 'base-1', name: 'Product tracker', schemaVersion: 1, tableOrder: ['tasks'], tables: { tasks: { id: 'tasks', name: 'Tasks', primaryFieldId: 'title', fieldOrder: ['title', 'status'], fields: { title: { id: 'title', name: 'Title', type: 'text', config: {} }, status: { id: 'status', name: 'Status', type: 'singleSelect', config: {} }, }, recordOrder: ['rec-1'], records: { 'rec-1': { id: 'rec-1', values: { title: 'Write docs', status: 'In progress' }, orderKey: 'a0', createdAt: Date.now(), updatedAt: Date.now(), }, }, views: {}, viewOrder: [], }, }, createdAt: Date.now(), updatedAt: Date.now(),}Utilisation
IBaseSnapshot sert les cas suivants :
- Créer une unité
UniverInstanceType.UNIVER_BASE. - Conserver et restaurer des données structurées.
- Préparer des données pour leur traitement côté serveur.
- Transférer des données entre les services de collaboration et les services d’importation et d’exportation.
Un objet instantané est des données de persistance. Une fois qu'une base est en cours d'exécution, utilisez le Facade API au lieu de muter l'instantané directement.
Enregistrer et restaurer
Appelez save() sur la Facade pour inclure des ressources de plugins enregistrés, tels que des tableaux de bord et des commentaires locaux. Dans l'exemple, saveToBackend représente la fonction de persistance de l'application:
const base = univerAPI.getActiveBase()if (!base) throw new Error('Open a Base first')await saveToBackend(base.save())Dans une nouvelle instance d'éditeur, enregistrez d'abord les mêmes plugins, puis restaurez avec univerAPI.createBase(savedSnapshot). Ne persistez pas seulement tables et ne mutez pas l'instantané du modèle en cours d'exécution.
Que pensez-vous de ce guide ?