ai-mysql für Entwickler

ai-mysql beantwortet die API von oxmysql exakt (Signaturen, Callback-Regeln, Ergebnisformen), daher gilt die Dokumentation von oxmysql selbst. Diese Seite listet auf, was es beantwortet, und die Details, auf die es ankommt.

Aus Lua verwendenCopy Anchor Link

Lade den Wrapper von oxmysql; der Pfad wird auf ai-mysql aufgelöst:

server_script '@oxmysql/lib/MySQL.lua'

-- Wartet auf das Ergebnis: in einem Thread oder Event-Handler aufrufen.
local row = MySQL.single.await('SELECT money FROM my_accounts WHERE owner = ?', { identifier })

-- Callback-Form: wartet nicht.
MySQL.update('UPDATE my_accounts SET money = money - ? WHERE owner = ? AND money >= ?', { 100, identifier, 100 }, function(affected)
    if affected == 1 then print('paid') end
end)

ExportsCopy Anchor Link

Jeder Export läuft serverseitig und antwortet unter exports['ai-mysql'] und exports.oxmysql. Jeder nimmt (query, params?, callback?):

• query: der SQL-Text, mit Platzhaltern ? oder benannten Platzhaltern @name / :name.
• params: ein Array für ?, ein Objekt für benannte Platzhalter. Kann weggelassen werden; der Callback kann dann das zweite Argument sein.
• callback: wird mit dem Ergebnis aufgerufen. Ohne ihn läuft der Aufruf trotzdem.

Jeder Export hat außerdem eine Promise-Form <name>_async und <name>Sync (query_async(query, params) gibt ein Promise zurück, das bei einem Fehler abgelehnt wird).

transactionCopy Anchor Link

Führt mehrere Anweisungen auf einer Verbindung aus; alle gelingen oder keine.

Seite: Server · Wartet: nein (antwortet über den Callback; transaction_async gibt ein Promise zurück)

transaction(queries: Array<string | [string, unknown[] | object] | { query: string; values?: unknown[] | object; parameters?: unknown[] | object }>, params?: unknown[] | object, cb?: (committed: boolean) => void): void

local ok = MySQL.transaction.await({
    { query = 'UPDATE my_accounts SET money = money - ? WHERE owner = ?', values = { 100, from } },
    { query = 'UPDATE my_accounts SET money = money + ? WHERE owner = ?', values = { 100, to } },
})

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

Nichts direkt; der Callback bekommt true oder false. Ein Rollback gibt den Fehler in der Konsole aus und löst oxmysql:transaction-error aus.

startTransactionCopy Anchor Link

Öffnet eine Transaktion und gibt deiner Funktion einen daran gebundenen Helfer query. Gib false aus deiner Funktion zurück, um ein Rollback auszulösen. Nach 30 Sekunden läuft sie ab.

Seite: Server · Wartet: ja (Promise)

startTransaction(work: (query: (sql: string, params?: unknown[] | object) => Promise<unknown>) => Promise<boolean | void>): Promise<boolean>

RückgabewertCopy Anchor Link

Promise<boolean>: true bei Commit. false, wenn deine Funktion false zurückgegeben oder einen Fehler geworfen hat oder die 30 Sekunden abgelaufen sind.

BeispielCopy Anchor Link

// Eine einfache JavaScript- oder TypeScript-Ressource ohne @aicore-fivem/mysql.
const db = exports.oxmysql;

async function pay(from: string, to: string, amount: number): Promise<boolean> {
  return db.startTransaction(async (query: (sql: string, params?: unknown[]) => Promise<any>) => {
    const res = await query("UPDATE my_accounts SET money = money - ? WHERE owner = ? AND money >= ?", [amount, from, amount]);
    if (res.affectedRows !== 1) return false; // nicht genug Geld: Rollback
    await query("UPDATE my_accounts SET money = money + ? WHERE owner = ?", [amount, to]);
  });
}

Alte Export-NamenCopy Anchor Link

Callback- und FehlerregelnCopy Anchor Link

Diese folgen oxmysql:

• Erfolg: Der Callback bekommt das Ergebnis.
• Fehler bei einer Promise-Form (oder .await in Lua): Das Promise wird mit dem Fehlertext abgelehnt.
• Fehler bei einem einfachen Callback: Der Fehler wird in der Konsole ausgegeben, und der Callback wird nicht aufgerufen.

EventsCopy Anchor Link

oxmysql:errorCopy Anchor Link

Seite: Server (lokal) · wird ausgelöst, wenn eine Abfrage fehlschlägt.

oxmysql:transaction-errorCopy Anchor Link

Seite: Server (lokal) · wird ausgelöst, wenn eine transaction ein Rollback macht. Payload { message: string, resource: string }.

on("oxmysql:error", (e: { query?: string; message: string; resource: string }) => {
  console.log(`[db] ${e.resource}: ${e.message} (${e.query ?? "?"})`);
});