Skip to main content

All documentation pages

Every published page, grouped by section and product. Use search or the product guides for a guided path.

Get started

Concepts

Analytics

  • Create and manage a saved query

    Create a query, find it, edit it safely, and remove it when it is no longer needed through TaruviBase Console.

  • Analytics overview

    Run saved, read-only queries with different values each time, against your site's own data or an external database.

  • Query your own site's data

    Write an internal query against your app's own data tables, using logical table names and no credentials.

  • Save, run, and delete a query

    Save a self-contained internal query, run it, and remove everything you created.

  • How saved queries work

    Understand saved queries, connection modes, table references, placeholders and bound values, and what an execution produces.

  • Connect an external database

    Store credentials as a connection secret and create a query that runs against a database outside the platform.

  • Run a query and read the results

    Run a saved query with the JavaScript or Python SDK, read the response, and preview or export returned rows in TaruviBase Console.

  • Analytics security and limits

    Apply least privilege, rely on automatic enforcement where it exists, protect destructive changes, and know the limits that are actually enforced.

  • Troubleshoot Analytics

    Match the symptom to its cause, whether a query will not save, will not run, or returns something unexpected.

  • Analytics connectors and execution reference

    Connector support, connection secret types, error categories, and interface support for Analytics.

Users and authentication

Access policies

Database

  • Search records

    Understand full-text, vector, and hybrid search behavior and the interfaces available for each mode.

  • Tables and schemas

    Understand how logical tables, stored schemas, materialized storage, keys, and records fit together inside a TaruviBase app.

  • Plan the table lifecycle

    Take a Database table from schema design through provisioning, verification, schema changes, and retirement.

  • Work with Database in TaruviBase Console

    Inspect tables, then add, browse, filter, edit, and delete records in TaruviBase Console.

  • Connect a Refine application

    Register TaruviBase's Refine data provider and use its Database read and query workflows.

  • Database reliability

    Design Database writes, retries, schema changes, and event consumers around clear transaction and delivery boundaries.

  • Database

    Build app data with structured tables, typed records, composable queries, relationships, and aggregations.

  • Build hierarchies and graphs

    Build parent-child trees, DAGs, and typed graph connections with app-scoped Database records.

  • Database storage models

    Choose between managed relational tables and whole-table JSONB storage.

  • Work with records

    Create, read, update, upsert, and delete Database records through each supported TaruviBase interface.

  • Plan schema changes

    Prepare, review, apply, and verify a Database schema change with a staged migration and recovery plan.

  • Use Database with async Python

    Run TaruviBase Database queries and record operations with the asynchronous Python client.

  • Test Database access policies

    Verify allow, deny, anonymous, cross-app, and cross-site behavior before deploying an application workflow.

  • Read, update, and delete a task

    Read the task created in Get Started, mark it complete, and remove it with TaruviBase Database.

  • Import, export, and migrate data

    Import and export records with explicit identifiers, verified batches, and resumable checkpoints.

  • Schema reference

    Reference the fields, constraints, primary-key convention, and foreign keys used by TaruviBase managed tables.

  • Run bulk operations

    Create, update, and delete multiple Database records in bounded requests.

  • Plan indexes

    Decide when a Database query needs an index and prepare a measured index change for a managed TaruviBase table.

  • Requests, responses, and errors

    Read Database success responses, operation-specific result shapes, totals, and structured API errors.

  • Filter operators

    Compose logical groups, negation, set, text, null, array, and range filters for Database records.

  • Query records

    Filter, sort, project, count, and paginate Database records.

  • Model and read relationships

    Connect app-scoped tables with foreign keys, junction records, and explicit related-table reads.

  • Database security and limits

    Protect Database resources with scoped requests, least-privilege access, bounded queries, and deliberate data changes.

  • Aggregate records

    Count, group, summarize, and filter Database records with aggregate queries.

  • Troubleshoot Database

    Resolve common Database scope, credential, schema, record, query, relationship, and timeout issues.

  • Database interface support

    Choose the TaruviBase Database interface that supports each developer workflow.

Events

  • Event registry and subscribers

    Understand TaruviBase's fixed event names and how subscriptions link them to your functions.

  • Manage event subscriptions

    Subscribe and unsubscribe functions and list an app's subscribers in the Console or with the REST API.

  • Events

    Run your functions automatically when site users or data table records change.

  • Event types

    Look up TaruviBase's fixed event names and when each one fires.

  • Emission and delivery

    Learn where TaruviBase emits events, payload shapes, dispatch filtering, and PRE_USER_CREATE blocking behavior.

  • Test event subscription access

    Verify allowed and denied subscription and inspection calls before enabling Events in production.

  • Subscribe to your first event

    List registry events, subscribe one app function to RECORD_CREATE, and verify the subscription for your app.

  • Events security and limits

    See who can manage event subscriptions, what payloads contain, and the limits that apply to Events.

  • Troubleshoot Events

    Diagnose subscription, permission, validation, and delivery issues for TaruviBase Events without exposing credentials.

  • Events REST API

    Look up cloud and app-scoped Events endpoints, request bodies, and observed HTTP status codes.

Frontend workers

Functions

Secrets

  • Secrets overview

    Store typed site- and app-scoped configuration values outside application code.

  • Store and inspect your first secret

    Use TaruviBase Console to create a secret type, store a site secret, inspect it safely, and remove the disposable resources.

  • Secrets concepts

    Understand secret types, sensitivity levels, site and app scope, resolution precedence, tags, and audit history.

  • Manage secrets in TaruviBase Console

    Create, inspect, edit, and delete secret types and site/app secrets in TaruviBase Console.

  • Read secrets from an SDK

    Read one or several Secrets values at application runtime with the JavaScript or Python SDK.

  • Secrets security and limits

    Review the secret access model, encryption, tenancy, immutable fields, destructive deletion, and limit status.

  • Troubleshoot secrets

    Resolve secret scope, credential, sensitivity, validation, and type-deletion failures without exposing values.

  • Secrets runtime reference

    Look up Secrets SDK read methods, options, response shapes, scope behavior, and current interface limits.

Storage

Build

  • Choose how you build

    Choose a TaruviBase SDK, the Refine integration, or HTTP requests to connect your application, and pick the right credential for where your code runs.

  • JavaScript SDK

    Install @taruvi/sdk, create a client for the browser, a server, or React Native, and make your first request.

  • Authenticate with the JavaScript SDK

    Add TaruviBase hosted sign-in to a browser app, check and end sessions, and call TaruviBase from a server with @taruvi/sdk.

  • Deploy with GitHub Actions

    Build your app and deploy it to TaruviBase on every push, with one TaruviBase site per branch.

  • JavaScript SDK reference

    Every @taruvi/sdk service, builder method, client option, error class, and enum, with the HTTP request each one sends.

  • Python SDK

    Install the taruvi package, create a synchronous or asynchronous client, and make your first request from Python.

  • Authenticate with the Python SDK

    Choose an API key, session token, or JWT for the taruvi Python client, sign in from an existing client, and use the client TaruviBase passes to function code.

  • Python SDK reference

    Every taruvi client module, query builder method, option, and exception, with the HTTP request each one sends.

  • Refine integration

    Connect a Refine 5 app to TaruviBase data, sign-in, storage, users, and access policies with @taruvi/refine-providers.

  • Refine provider reference

    Resources, operations, meta options, filter operators, and settings for each provider in @taruvi/refine-providers.

Releases

  • Releases

    New TaruviBase features, improvements, security updates, and important product changes.

  • Version compatibility

    Check the API and SDK versions used by the published TaruviBase guides.