DisBot
    Preparing search index...

    Class MetricsClient

    Index

    Constructors

    constructor

    Methods

    json prometheus

    Constructors

    • Parameters

      • client: {
            _accelerateEngineConfig: AccelerateEngineConfig;
            _activeProvider: string;
            _appliedParent: any;
            _clientVersion: string;
            _connectionPromise?: Promise<any>;
            _createPrismaPromise: PrismaPromiseFactory;
            _disconnectionPromise?: Promise<any>;
            _engine: Engine;
            _engineConfig: EngineConfig;
            _errorFormat: ErrorFormat;
            _extensions: MergedExtensionsList;
            _globalOmit?: GlobalOmitOptions;
            _originalClient: any;
            _previewFeatures: string[];
            _requestHandler: RequestHandler;
            _runtimeDataModel: RuntimeDataModel;
            _tracingHelper: TracingHelper;
            "[toStringTag]": string;
            $extends: (
                this: { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; },
                extension:
                    | ExtensionArgs
                    | (
                        (
                            client: { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; },
                        ) => { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; }
                    ),
            ) => { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; };
            $metrics: MetricsClient;
            _createItxClient(
                transaction: PrismaPromiseInteractiveTransaction,
            ): { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; };
            _executeRequest(__namedParameters: InternalRequestParams): Promise<any>;
            _hasPreviewFlag(feature: string): boolean;
            _request(internalParams: InternalRequestParams): Promise<any>;
            _transactionWithArray(
                __namedParameters: {
                    options?: BatchTransactionOptions;
                    promises: PrismaPromise_2<any, any>[];
                },
            ): Promise<any>;
            _transactionWithCallback(
                __namedParameters: {
                    callback: (
                        client: { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; },
                    ) => Promise<unknown>;
                    options?: Options;
                },
            ): Promise<unknown>;
            $applyPendingMigrations(): Promise<void>;
            $connect(): Promise<void>;
            $disconnect(): Promise<void>;
            $executeRaw(
                query: TemplateStringsArray | Sql,
                ...values: any[],
            ): PrismaPromise_2<unknown, any>;
            $executeRawInternal(
                transaction: PrismaPromiseTransaction<unknown>,
                clientMethod: string,
                args: RawQueryArgs,
                middlewareArgsMapper?: MiddlewareArgsMapper<unknown, unknown>,
            ): Promise<number>;
            $executeRawUnsafe(
                query: string,
                ...values: unknown[],
            ): PrismaPromise_2<unknown, any>;
            $on<E extends ExtendedEventType>(
                eventType: E,
                callback: EventCallback<E>,
            ): any;
            $queryRaw(
                query: TemplateStringsArray | Sql,
                ...values: any[],
            ): PrismaPromise_2<unknown, any>;
            $queryRawInternal(
                transaction: PrismaPromiseTransaction<unknown>,
                clientMethod: string,
                args: RawQueryArgs,
                middlewareArgsMapper?: MiddlewareArgsMapper<unknown, unknown>,
            ): Promise<any>;
            $queryRawTyped(typedSql: UnknownTypedSql): PrismaPromise_2<unknown, any>;
            $queryRawUnsafe(
                query: string,
                ...values: unknown[],
            ): PrismaPromise_2<unknown, any>;
            $runCommandRaw(
                command: Record<string, JsInputValue>,
            ): PrismaPromise_2<unknown, any>;
            $transaction(input: any, options?: any): Promise<any>;
        }
        • _accelerateEngineConfig: AccelerateEngineConfig
        • _activeProvider: string
        • _appliedParent: any

          A fully constructed/applied Client that references the parent PrismaClient. This is used for Client extensions only.

        • _clientVersion: string
        • Optional_connectionPromise?: Promise<any>
        • _createPrismaPromise: PrismaPromiseFactory
        • Optional_disconnectionPromise?: Promise<any>
        • _engine: Engine

          This is used internally by Policy, do not rename or remove

        • _engineConfig: EngineConfig
        • _errorFormat: ErrorFormat
        • _extensions: MergedExtensionsList
        • Optional_globalOmit?: GlobalOmitOptions
        • _originalClient: any
        • _previewFeatures: string[]
        • _requestHandler: RequestHandler
        • _runtimeDataModel: RuntimeDataModel
        • _tracingHelper: TracingHelper
        • Readonly[toStringTag]: string
        • $extends: (
              this: { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; },
              extension:
                  | ExtensionArgs
                  | (
                      (
                          client: { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; },
                      ) => { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; }
                  ),
          ) => { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; }
        • $metrics: MetricsClient
        • _createItxClient: function
          • _createItxClient(
                transaction: PrismaPromiseInteractiveTransaction,
            ): { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; }

            Parameters

            • transaction: PrismaPromiseInteractiveTransaction

            Returns { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; }

        • _executeRequest: function
          • _executeRequest(__namedParameters: InternalRequestParams): Promise<any>

            Parameters

            • __namedParameters: InternalRequestParams

            Returns Promise<any>

        • _hasPreviewFlag: function
        • _request: function
          • _request(internalParams: InternalRequestParams): Promise<any>

            Runs the middlewares over params before executing a request

            Parameters

            • internalParams: InternalRequestParams

            Returns Promise<any>

        • _transactionWithArray: function
          • _transactionWithArray(
                __namedParameters: {
                    options?: BatchTransactionOptions;
                    promises: PrismaPromise_2<any, any>[];
                },
            ): Promise<any>

            Execute a batch of requests in a transaction

            Parameters

            • __namedParameters: { options?: BatchTransactionOptions; promises: PrismaPromise_2<any, any>[] }

            Returns Promise<any>

        • _transactionWithCallback: function
          • _transactionWithCallback(
                __namedParameters: {
                    callback: (
                        client: { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; },
                    ) => Promise<unknown>;
                    options?: Options;
                },
            ): Promise<unknown>

            Perform a long-running transaction

            Parameters

            • __namedParameters: {
                  callback: (
                      client: { _originalClient: any; _runtimeDataModel: RuntimeDataModel; _requestHandler: RequestHandler; _connectionPromise?: Promise<any>; _disconnectionPromise?: Promise<...>; ... 33 more ...; readonly [Symbol.toStringTag]: string; },
                  ) => Promise<unknown>;
                  options?: Options;
              }

            Returns Promise<unknown>

        • $applyPendingMigrations: function
        • $connect: function
        • $disconnect: function
        • $executeRaw: function
        • $executeRawInternal: function
          • $executeRawInternal(
                transaction: PrismaPromiseTransaction<unknown>,
                clientMethod: string,
                args: RawQueryArgs,
                middlewareArgsMapper?: MiddlewareArgsMapper<unknown, unknown>,
            ): Promise<number>

            Executes a raw query and always returns a number

            Parameters

            • transaction: PrismaPromiseTransaction<unknown>
            • clientMethod: string
            • args: RawQueryArgs
            • OptionalmiddlewareArgsMapper: MiddlewareArgsMapper<unknown, unknown>

            Returns Promise<number>

        • $executeRawUnsafe: function
        • $on: function
          • $on<E extends ExtendedEventType>(eventType: E, callback: EventCallback<E>): any

            Type Parameters

            • E extends ExtendedEventType

            Parameters

            • eventType: E
            • callback: EventCallback<E>

            Returns any

        • $queryRaw: function
        • $queryRawInternal: function
          • $queryRawInternal(
                transaction: PrismaPromiseTransaction<unknown>,
                clientMethod: string,
                args: RawQueryArgs,
                middlewareArgsMapper?: MiddlewareArgsMapper<unknown, unknown>,
            ): Promise<any>

            Executes a raw query and returns selected data

            Parameters

            • transaction: PrismaPromiseTransaction<unknown>
            • clientMethod: string
            • args: RawQueryArgs
            • OptionalmiddlewareArgsMapper: MiddlewareArgsMapper<unknown, unknown>

            Returns Promise<any>

        • $queryRawTyped: function
        • $queryRawUnsafe: function
        • $runCommandRaw: function
        • $transaction: function
          • $transaction(input: any, options?: any): Promise<any>

            Execute queries within a transaction

            Parameters

            • input: any

              a callback or a query list

            • Optionaloptions: any

              to set timeouts (callback)

            Returns Promise<any>

      Returns MetricsClient

    Methods

    • Returns all metrics gathered up to this point in prometheus format. Result of this call can be exposed directly to prometheus scraping endpoint

      Parameters

      • Optionaloptions: MetricsOptions

      Returns Promise<string>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods