Test Database Aggregate

Test-run an aggregation pipeline with caller-supplied tokens.

An aggregate is a saved MongoDB aggregation pipeline you can run to compute, group, and summarise data. Tests the database aggregate.

This method is on the Hub surface (norbix.hub.database) — call it from admin tooling or IaC.

These examples assume the SDK is installed and your credentials are set as environment variables — each client reads them automatically, so the constructors below take no arguments. See Install a Norbix SDK.

JavaScript / TypeScript

import { Norbix } from '@norbix.ai/ts';
const norbix = new Norbix();

const result = await norbix.hub.database.testDatabaseAggregate({
  collectionName: 'orders',
  pipeline: '[{"$match":{"status":"active"}}]',
  databaseIntegrationId: 'int_4kX9mQvR2tYw7ZbC1dFgHj',
});

.NET

using Norbix.Sdk;
using Norbix.Sdk.Types.Hub;

using var client = new NorbixClient();

var result = await client.Database.TestDatabaseAggregateAsync(new TestDatabaseAggregateRequest
{
    CollectionName = "orders",
    Pipeline = "[{\"$match\":{\"status\":\"active\"}}]",
    DatabaseIntegrationId = "int_4kX9mQvR2tYw7ZbC1dFgHj",
});

Python

from norbix_python import NorbixHub

norbix = NorbixHub()

result = norbix.database.test_database_aggregate(
    collectionName="orders",
    pipeline="[{\"$match\":{\"status\":\"active\"}}]",
    databaseIntegrationId="int_4kX9mQvR2tYw7ZbC1dFgHj",
)

Go

c, _ := norbix.New(norbix.Options{})
ctx := context.Background()

var result map[string]any
err := c.Hub.Database.TestDatabaseAggregate(ctx, map[string]any{
	"collectionName": "orders",
	"pipeline": "[{\"$match\":{\"status\":\"active\"}}]",
	"databaseIntegrationId": "int_4kX9mQvR2tYw7ZbC1dFgHj",
}, &result)

Dart / Flutter

import 'package:norbix/norbix_hub.dart';

final hub = NorbixHub();

final result = await hub.database.testDatabaseAggregate(body: {
  'collectionName': 'orders',
  'pipeline': '[{"$match":{"status":"active"}}]',
  'databaseIntegrationId': 'int_4kX9mQvR2tYw7ZbC1dFgHj',
});

Swift

import NorbixSwift

let client = Norbix()

let result = try await client.hub.database.testDatabaseAggregate([
    "collectionName": "orders",
    "pipeline": "[{\"$match\":{\"status\":\"active\"}}]",
    "databaseIntegrationId": "int_4kX9mQvR2tYw7ZbC1dFgHj",
])

Kotlin

import dev.norbix.sdk.hub.NorbixHub

val hub = NorbixHub()

val result = hub.database.testDatabaseAggregate(mapOf(
    "collectionName" to "orders",
    "pipeline" to "[{\"$match\":{\"status\":\"active\"}}]",
    "databaseIntegrationId" to "int_4kX9mQvR2tYw7ZbC1dFgHj",
))

CLI

norbix hub db aggregate test --collectionName orders --pipeline '[{"$match":{"status":"active"}}]' --databaseIntegrationId int_4kX9mQvR2tYw7ZbC1dFgHj

In the dashboard

Manage this visually in Norbix Cloud — see Database → Aggregates.

API reference

Full request and response for this endpoint: Test Database Aggregate.