api.truncateDatabase()

​

api.truncateDatabase()

• Unavailable with readOnly: true (throws an error).
• TRUNCATE does not create row audit events, even when database audit is enabled.
• Use an ordinary filtered delete, such as primary key IS NOT NULL, to preserve row audit events.
• Identity counters are preserved by default.
• Set restartIdentity only when generated key reuse is explicitly intended.

​

Signature

static truncateDatabase(
      name: string,
      options?: TruncateDatabaseOptions,
    ): Promise<void>;

​

Example

await api.truncateDatabase('orders', { restartIdentity: false });