Overview

Product Tour

Using a starter

Adding Tina to existing NextJS site

Getting Started

Using the Tina editor

The JavaScript toolkit for building content management interfaces

Content Modeling

Data Fetching

Contextual Editing

Running the Local GraphQL API

Getting a Single Document

Filtering

Sorting

Paginating

Performance

Limitations

Querying a Collection

Updating a Document

Adding a Document

Querying the API

Autogenerated GraphQL Client

Read Only Tokens

Markdown

Rich Text with MDX

Block-based editing

Active Field Indicator

Editing

Validation

Custom field components

Custom List Rendering

Format and parse input

Extending Tina

Powerful Git-based content management for teams

Registration

Projects

Users

Tina Cloud Dashboard

Connecting the site

API Versioning

Branching

Data Layer

Adding Internationalization to Tina

Non-React-based SSG support

Collections

Fields

Templates

string

number

datetime

boolean

image

reference

object

rich-text

Field Types

Schema

".tina" folder

The TinaCMS CLI

Cloudinary

Media

Tina's edit state

The CMS

Forms

Text

Text Area

Number

Image

Color

Toggle

Radio Group

Select

List

Group

Group List

Blocks

Date & Time

HTML

Field Plugins

CMS Toolkit


{{ WarningCallout text="This is an experimental feature, and the API is subject to change. Have any thoughts? Let us know in the chat, or through one of our [community channels](/community/)!" }}

Tina Cloud now supports an optional Data Layer which implements a database layer between the Tina GraphQL API and the
GitHub REST API. This data layer buffers requests between Tina Cloud and GitHub resulting in improved editing
performance with TinaCMS. It also enables additional capabilities such as:

- [sorting](/docs/graphql/queries/advanced/sorting/)
- [filtering](/docs/graphql/queries/advanced/filter-documents/)
- [pagination](/docs/graphql/queries/advanced/pagination/)
- referential integrity

# Enabling the Data Layer

The TinaCMS data layer is enabled by specifying the following TinaCMS command line flag: `--experimentalData`. We
recommend editing the script(s) in your site's package.json to pass the flag:

```json
"start": "yarn tinacms server:start -c \"next start\" --experimentalData"
```

To opt-in to the frontend features of the datalayer you must set the `experimentalData` flag in the `cmsCallback` to true.

```ts
cmsCallback: (cms) => {
   cms.flags.set("experimentalData", true);
},
```

Once the flag is added and the TinaCMS CLI is executed using the flag, the generated schema will be updated. **These
updates must be committed and pushed to the remote GitHub repository in order to activate the data layer.**

# Indexing

Once the data layer is enabled, Tina Cloud will automatically maintain a synchronized copy of your repository in our
secure cloud database. We refer to this synchronization process as indexing. It involves fetching each item from your
GitHub remote repository and storing a copy in the database. After the initial indexing process, Tina Cloud will only
index content that has been updated. There are some circumstances where a full re-indexing may be required. Some example
scenarios are:
- Changes to `.tina/schema.ts`
- Changes to the [path to tina](/docs/tina-cloud/faq/#does-tina-cloud-work-with-monorepos)
- Changes to the configured [repository](/docs/tina-cloud/dashboard/projects/#changing-the-repository)
- New branches in GitHub

# Caveats

There are some issues to be aware of when using the data layer: 

- We offer a server command to poll for the status of indexing: `server:waitForDB`.  When using `server:start`, `server:waitForDB` is automatically called if you have configured `client.ts`.
  - You can learn more about `server:waitForDB` [here](/docs/cli-overview/#tinacms-serverwaitfordb-experimental).

- Since the GitHub API currently only allows 5,000 requests per repository per hour, any repositories with large numbers
of items may not be able to complete indexing before hitting the limit. For this reason, this feature should not be
activated for repositories with more than 1000-1500 items.

These issues will be addressed before this feature becomes the default for Tina Cloud.


Docs

Data Layer