Aggregate

Aggregate.

Collections hold your records. Norbix generates a full CRUD + query API over each collection from its schema, with record-level ownership and triggers. Runs an aggregation for it.

This method is on the runtime API surface (norbix.api.database) — call it from your app.

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.api.database.aggregate({
  collectionName: 'orders',
  databaseIntegrationId: 'int_4kX9mQvR2tYw7ZbC1dFgHj',
  pipeline: '[{"$match":{"status":"active"}}]',
});

.NET

using Norbix.Sdk;
using Norbix.Sdk.Types.Api;

using var client = new NorbixClient();

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

Python

from norbix_python import NorbixApi

norbix = NorbixApi()

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

Go

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

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

Dart / Flutter

import 'package:norbix/norbix_api.dart';

final api = NorbixApi();

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

Swift

import NorbixSwift

let client = Norbix()

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

Kotlin

import dev.norbix.sdk.api.NorbixApi

val api = NorbixApi()

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

CLI

norbix db aggregate orders --pipeline '[{"$match":{"status":"active"}}]'

In the dashboard

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

API reference

Full request and response for this endpoint: Aggregate.