#SingleRecordResource

Eine auf einzelne Datensätze ausgerichtete Resource: Die Daten bestehen aus einem einzelnen Objekt. Sie unterstützt das Abrufen per Hauptschlüssel, das Erstellen/Aktualisieren (save) sowie das Löschen. Sie eignet sich für Szenarien mit „einzelnen Datensätzen“ wie Details oder Formulare. Im Gegensatz zur MultiRecordResource gibt getData() bei der SingleRecordResource ein einzelnes Objekt zurück. Über setFilterByTk(id) wird der Hauptschlüssel festgelegt, und save() ruft je nach Zustand von isNewRecord automatisch create oder update auf.

Vererbungshierarchie: FlowResource → APIResource → BaseRecordResource → SingleRecordResource.

Erstellung: ctx.makeResource('SingleRecordResource') oder ctx.initResource('SingleRecordResource'). Vor der Verwendung muss setResourceName('Sammlungsname') aufgerufen werden. Bei Operationen über den Hauptschlüssel ist setFilterByTk(id) erforderlich. In RunJS wird ctx.api durch die Laufzeitumgebung injiziert.

#Anwendungsszenarien

#Datenformat

• getData() gibt ein einzelnes Datensatz-Objekt zurück, was dem Feld data der Get-Schnittstelle entspricht.
• getMeta() gibt Metainformationen zurück (falls vorhanden).

#Ressourcenname und Hauptschlüssel

#Status

#Abfrageparameter (Filter / Felder)

#CRUD

#Konfiguration und Ereignisse

#Beispiele

#Grundlegendes Abrufen und Aktualisieren

ctx.initResource('SingleRecordResource');
ctx.resource.setResourceName('users');
ctx.resource.setFilterByTk(1);
await ctx.resource.refresh();
const user = ctx.resource.getData();

// Aktualisieren
await ctx.resource.save({ name: 'Max Mustermann' });

#Neuen Datensatz erstellen

const newRes = ctx.makeResource('SingleRecordResource');
newRes.setResourceName('users');
await newRes.save({ name: 'Erika Musterfrau', email: 'erika@example.com' });

#Datensatz löschen

ctx.resource.setResourceName('users');
ctx.resource.setFilterByTk(1);
await ctx.resource.destroy();
// Nach destroy() ist getData() null

#Verknüpfungserweiterungen und Felder

ctx.resource.setResourceName('users');
ctx.resource.setFilterByTk(1);
ctx.resource.setFields(['id', 'nickname', 'email']);
ctx.resource.setAppends(['profile', 'roles']);
await ctx.resource.refresh();
const user = ctx.resource.getData();

#Verknüpfte Ressourcen (z. B. users.profile)

const res = ctx.makeResource('SingleRecordResource');
res.setResourceName('users.profile');
res.setSourceId(ctx.record?.id); // Hauptschlüssel des übergeordneten Datensatzes
res.setFilterByTk(profileId);    // Wenn profile eine hasOne-Beziehung ist, kann filterByTk weggelassen werden
await res.refresh();
const profile = res.getData();

#Speichern ohne automatische Aktualisierung

await ctx.resource.save({ status: 'active' }, { refresh: false });
// Nach dem Speichern wird refresh nicht ausgelöst, getData() behält den alten Wert

#Auf refresh / saved Ereignisse hören

ctx.resource?.on?.('refresh', () => {
  const data = ctx.resource.getData();
  ctx.render(<div>Benutzer: {data?.nickname}</div>);
});
ctx.resource?.on?.('saved', (savedData) => {
  ctx.message.success('Erfolgreich gespeichert');
});
await ctx.resource?.refresh?.();

#Hinweise

• setResourceName ist erforderlich: Vor der Verwendung müssen Sie setResourceName('Sammlungsname') aufrufen, da sonst die Anfrage-URL nicht erstellt werden kann.
• filterByTk und isNewRecord: Wenn setFilterByTk nicht gesetzt ist, ist isNewRecord true und refresh() sendet keine Anfrage; save() führt dann ein create aus.
• Verknüpfte Ressourcen: Wenn der Ressourcenname im Format parent.child vorliegt (z. B. users.profile), müssen Sie zuerst setSourceId(Hauptschlüssel des Eltern-Datensatzes) aufrufen.
• getData ist ein Objekt: Die von der Single-Schnittstelle zurückgegebenen data sind ein Datensatz-Objekt; getData() gibt dieses Objekt direkt zurück. Nach destroy() ist der Wert null.

#Verwandte Themen

• ctx.resource – Die Resource-Instanz im aktuellen Kontext
• ctx.initResource() – Initialisieren und an ctx.resource binden
• ctx.makeResource() – Neue Resource-Instanz erstellen, ohne Bindung
• APIResource – Allgemeine API-Ressource, Abfrage per URL
• MultiRecordResource – Ausgerichtet auf Sammlungen/Listen, unterstützt CRUD und Paginierung