proactive-deps
    Preparing search index...

    Type Alias DatabaseCheckDetails

    Defines the structure of a Database check details.

    const databaseCheckDetails: DatabaseCheckDetails = {
      type: 'database',
      server: 'localhost',
      database: 'mydb',
      dbType: 'mysql',
      connectionString: 'mysql://user:password@localhost/mydb', // do not expose real authentication tokens here
      proc: 'GetUserById',
      query: 'SELECT * FROM users WHERE id = 1',
      timeoutMs: 5000,
      expectedRowCount: 1,
      expectedResponse: 'John Doe',
    };
    type DatabaseCheckDetails = {
        connectionString?: string;
        database: string;
        dbType?: string;
        expectedResponse?: string | RegExp;
        expectedRowCount?: number;
        proc?: string;
        query?: string;
        server: string;
        timeoutMs?: number;
        type: "database";
    }
    Index

    Properties

    connectionString? database dbType? expectedResponse? expectedRowCount? proc? query? server timeoutMs? type

    Properties

    connectionString?: string

    The connection string used to connect to the database. Do not provide real authentication tokens here. These are just examples.

    database: string

    The name of the database to connect to.

    dbType?: string

    The type of database (e.g., MySQL, PostgreSQL, etc.). This is optional and can be used to specify the database type if needed.

    expectedResponse?: string | RegExp

    Optional description of value in response being checked for.

    expectedRowCount?: number

    Optional The expected number of rows returned from the query.

    proc?: string

    Optional stored procedure being executed to check the database connection.

    query?: string

    Optional SQL query being executed to check the database connection.

    server: string

    The server name or IP address of the database.

    timeoutMs?: number

    Optional timeout in milliseconds for the database query.

    type: "database"

    The type of check, which is 'database' in this case.

    Settings

    Member Visibility

    On This Page

    Properties