All documentation pages
Every published page, grouped by section and product. Use search or the product guides for a guided path.
Get started
- Get started with TaruviBase
Choose your path to build with TaruviBase.
- Create your first TaruviBase app
Set up a Development site and app in TaruviBase Console.
- Integrate TaruviBase with your framework
Connect your framework to TaruviBase using the TaruviBase Agents Plugin and your AI coding assistant.
- Create your first task
Create a task from application code, read it back, and confirm it in TaruviBase Console in under 15 minutes.
- Build with AI
Connect your AI coding tool to a TaruviBase app and let it build features for you.
Concepts
- Resource lifecycle and deletion
Understand how TaruviBase disables, restores, and permanently deletes app and organization resources.
- Tenancy and request scope
Understand how a site's address and an app slug decide which data a TaruviBase request reaches.
- Authentication and authorization model
Learn which credentials TaruviBase accepts and how it decides what a caller may do.
- API request lifecycle
Follow a TaruviBase request from your application to its response, and debug failures in order.
- Platform architecture
See how organizations, sites, apps, and TaruviBase's interfaces fit together.
- Capability lifecycle
Interpret generally available, preview, deprecated, and internal TaruviBase capabilities.
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
- Users and authentication
Manage site users, access, sessions, and API tokens in TaruviBase.
- Get started with site users
Create and verify a site user with the SDKs, Refine, REST, or Console.
- Users and authentication concepts
Find the identity, access, session, role, and attribute concepts for TaruviBase sites.
- Users and authentication how-to guides
Choose the focused procedure for a user, access, hosted-flow, token, or SSO task.
- Users and authentication security and limits
Review the verified scope, token, hosted-flow, and mutation boundaries.
- Troubleshoot users and authentication
Diagnose site-user, hosted-flow, token, and SSO problems without exposing credentials.
- Users and authentication reference
Find supported client surfaces, versions, and verified limits for users and authentication.
- Authentication sessions
Understand hosted sign-in, sign-up, logout, reset, and invitation acceptance boundaries.
- Cloud users and site users
Understand the four identity and access relationships used by TaruviBase.
- Roles and user attributes
Understand role membership, app access, and schema-governed user attributes.
- Issue API tokens
Create, store, list, and revoke user API tokens with the verified safety limits.
- Assign user access
Assign or revoke a site user's roles and check their app access.
- Get tokens and API keys
Sign in a user, create an API key, and obtain or refresh a JWT with the supported SDK and HTTP flows.
- Test hosted sign-in and recovery
Test hosted sign-in, recovery, logout, reset, and invitation outcomes.
- Configure OpenID Connect SSO
Configure the verified OpenID Connect provider fields in TaruviBase Console.
- Manage organization members
Add, invite, review, or remove organization members in TaruviBase Console.
- Manage referenced user attributes
Configure and safely maintain referenced user-attribute mappings in TaruviBase Console.
- Manage site roles
Create, change, assign, and safely remove site roles in TaruviBase Console.
- Manage site users
Create, find, update, and remove site users in Console, the SDKs, Refine, or the REST API.
- Configure user attributes
Configure a site's user-attribute schema before collecting attribute values.
- Manage user preferences
Read or update the authenticated user preferences with the SDKs or REST API.
- Authentication SDK and provider support
Review authentication SDK, Refine, hosted-flow, and OpenID Connect support boundaries.
Access policies
- Access policy concepts
Learn the decision model, policy types, roles, conditions, and system policies.
- Access decisions
Understand the caller, resource, action, condition, and allow or deny decision.
- Automatic system policies
Understand how TaruviBase synchronizes policies for system resources and how to recover when synchronization is incomplete.
- Roles, policies, and conditions
Distinguish App Roles, memberships, synchronized Role Policies, and access-policy types.
- Manage app roles
Create, assign, edit, verify, and safely delete application roles in TaruviBase Console.
- Add policy conditions
Use Console conditions to constrain an access decision by caller and resource facts.
- Use Database policy filters
Keep server policy filtering distinct from application UI and query filtering.
- Manage policies in the Console
Create, review, and replace access policy definitions using Console views.
- Check access at runtime
Ask TaruviBase what the caller may do, from the Python SDK, the JavaScript SDK, or Refine.
- Test access decisions
Verify allowed and denied decisions in Console Live testing before a policy release.
- Access policy guides
Find Console procedures for roles, policies, conditions, filters, decisions, and runtime checks.
- Access policies
Define and verify access policies for TaruviBase resources.
- Verify an access decision
Use Live testing in the Console to verify one allowed and one denied access decision.
- Access policies reference
Look up system resource actions, filter operators, and integration support.
- Policy filter operators
Look up supported Database policy filter operators and boundaries.
- System resource actions
Look up the actions available on system policy resources.
- Access policy SDK and provider support
See which SDKs and UI providers support access policy checks.
- Access policy security and limits
Review caller, policy, Database, Console, and runtime enforcement boundaries before release.
- Troubleshoot access policies
Diagnose policy scope, synchronization, condition, runtime, and Database enforcement failures safely.
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
- Frontend workers
Host static web apps—React, Vue, or plain HTML—on TaruviBase by uploading a zip of your build.
- Deploy and manage frontend workers
Deploy a static build from TaruviBase Console or the REST API, upload new versions, and choose which one is live.
- Frontend workers reference
REST API, archive rules, and access for frontend workers.
- Troubleshoot frontend workers
Diagnose forbidden uploads, archive validation failures, and slug constraints for frontend workers.
Functions
- Functions
Run app-scoped backend logic on demand, asynchronously, on a schedule, or from an event.
- Create, run, and delete a function
Create an app-mode function, run it, and remove it end to end.
- Functions security and limits
Understand the sandbox boundary, public functions, log visibility, and applied limits.
- Functions reference
Look up function endpoints, fields, execution modes, statuses, and observed limits.
- How execution modes differ
Compare app and proxy functions and choose the right mode.
- How a call becomes a result
Follow a function call from request to result, and understand sync and async.
- How versioning and revert work
Understand what creates a function version and exactly what revert restores.
- Filter conditions reference
Write CEL expressions that decide whether an event triggers a function.
- Work with Functions in TaruviBase Console
Create, edit, run, and inspect functions from the Console, and know which tabs each mode shows.
- Execute a function
Queue a function run, collect its result by task id, and control what reaches it.
- Read logs and invocations
Find past executions, read their captured output, and keep it safe to share.
- Forward a call to a webhook
Create a proxy function that forwards parameters to an external webhook.
- Run a function on a schedule
Attach cron schedules to a function and control when each one runs.
- Write a function
Write app-mode Python, save it as a new version, and move between versions.
- Troubleshoot Functions
Diagnose rejected code, failed executions, missing runs, timeouts, and truncated logs.
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
- Manage storage buckets
Create, update, inspect usage, and delete storage buckets.
- Storage overview
Store, organize, and serve application files with per-app buckets backed by S3 or SharePoint.
- Storage providers — S3 and SharePoint
Compare the S3 and SharePoint storage providers and choose the right one for each bucket.
- Work with storage objects
Upload, download, update metadata, and delete individual storage objects.
- Store your first file with TaruviBase Storage
Create a bucket, upload a file, download it, and clean up — from empty to verified in a few minutes.
- Storage filter grammar reference
Complete filter parameter list for the bucket and object list endpoints, plus the search and browse action bodies.
- Storage configured limits
The size, count, and timing limits TaruviBase Storage applies to uploads, metadata, batches, searches, and SharePoint access.
- How storage works
Buckets, objects, paths, visibility, providers, and quotas for TaruviBase Storage.
- Find, browse, copy, and move objects
List and filter objects, browse as folders, run advanced searches, copy to a new location, and move or rename within the same app.
- Batch operations and SharePoint access
Upload and delete objects in bulk with partial-success handling, and open Office files for in-browser view or edit on SharePoint-backed buckets.
- Storage security and limits
Who can use Storage, how access is decided, and what to expect for deletes and limits.
- Troubleshoot Storage
Diagnose common storage failures — uploads rejected, provider errors, permission denials, and SharePoint access issues.
- Storage REST and filter reference
Look up bucket and object endpoints, response envelopes, and where to find filter and limit details for TaruviBase 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.