Class Analyzer

Represents an Analyzer in a Database.

Hierarchy

  • Analyzer

Accessors

Methods

Accessors

  • get name(): string
  • Name of this Analyzer.

    See also Database.

    Returns string

Methods

  • Deletes the Analyzer from the database.

    Example

    const db = new Database();
    const analyzer = db.analyzer("some-analyzer");
    await analyzer.drop();
    // the Analyzer "some-analyzer" no longer exists

    Parameters

    • force: boolean = false

      Whether the Analyzer should still be deleted even if it is currently in use.

    Returns Promise<ArangoApiResponse<{
        name: string;
    }>>

  • Checks whether the Analyzer exists.

    Example

    const db = new Database();
    const analyzer = db.analyzer("some-analyzer");
    const result = await analyzer.exists();
    // result indicates whether the Analyzer exists

    Returns Promise<boolean>

Generated using TypeDoc