Blueprint
Overview
Blueprint is a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation.
Terms
- Blueprint — A collection of sheets that describe a complete dataset
- Sheet — A collection of fields that describe a single entity (eg. people, products, companies)
- Field — Describes an attribute of the entity (eg. name, email) and how it should behave
{
"sheets": [
{
"name": "Products",
"description": "A list of products available for sale",
"slug": "products",
"readOnly": false,
"allowAdditionalFields": false,
"access": ["add", "edit"],
"fields": [
{
"key": "code",
"label": "Product Code",
"type": "string"
},
{
"key": "description",
"type": "string"
},
{
"key": "price",
"type": "number"
}
],
"actions": [],
"metadata": {}
}
]
}
Sheet Options
Configure the basic behavior of your Sheet with Sheet-level options.
Field Types
Learn about the different field types and how to use them.
Field Constraints
Learn about the available constraints and how they work.
Field Relationships
Establish connections between Sheets and fields.
Access Control
Configure field, Sheet, and Workbook level user capabilities.
{
"sheets": [
{
"name": "Products",
"description": "A list of products available for sale",
"slug": "products",
"readOnly": false,
"allowAdditionalFields": false,
"access": ["add", "edit"],
"fields": [
{
"key": "code",
"label": "Product Code",
"type": "string"
},
{
"key": "description",
"type": "string"
},
{
"key": "price",
"type": "number"
}
],
"actions": [],
"metadata": {}
}
]
}