Guides

Releases

This is a reverse chronological list of the major TinyBase releases, with highlighted features.

The Basics

These guides cover the very basics of TinyBase.

• Getting Started
• Creating A Store
• Writing To Stores
• Reading From Stores
• Listening To Stores
• Transactions
• Importing TinyBase
• TinyBase and TypeScript

Building UIs

These guides cover how to use the ui-react module and use React hooks and components to easily build reactive user interfaces with TinyBase.

• Getting Started With ui-react
• Using React Hooks
• Using React Components
• Using Context

Schemas And Persistence

These guides discuss how to set up a ValuesSchema or TablesSchema on a Store so that certain structures of data are assured - and how to load and save data to a Store from a persistence layer.

• Using Schemas
• Schema-Based Typing
• Mutating Data With Listeners
• Persisting Data
• Custom Persistence

Metrics And Indexes

These guides discuss how to define Metrics that aggregate values together, and Indexes that allow fast access to matching Row objects.

• Using Metrics
• Building A UI With Metrics
• Advanced Metric Definition
• Using Indexes
• Building A UI With Indexes
• Advanced Index Definition

Relationships And Checkpoints

These guides discuss how to define Relationships that connect Rows together between Table objects, and Checkpoints that allow you to build undo and redo functionality.

• Using Relationships
• Building A UI With Relationships
• Advanced Relationship Definitions
• Using Checkpoints
• Building A UI With Checkpoints

Making Queries

These guides discuss how to define queries that let you select specific Row and Cell combinations from each Table, and benefit from powerful features like grouping and aggregation.

• Using Queries
• TinyQL
• Building A UI With Queries

Developer Tools

These guides discuss the developer tools that are available in TinyBase. These are not intended for production use, but are instead to be used as part of your engineering workflow to perform tasks like generating APIs from schemas, or schemas from data.

• Inferring TablesSchemas
• Generating APIs
• Gathering Statistics
• Command Line

How TinyBase Is Built

These guides discuss how TinyBase is structured and some of the interesting ways in which it is architected, tested, and built.

• Developing TinyBase
• Architecture
• Testing
• Documentation
• How The Demos Work
• Credits

FAQ

These are some of the feasibly asked questions about TinyBase. We can't assert that they're 'frequently asked' yet, since we just launched.