Databases tools.
Databases hold tables of rows beside your documents and plans. Create a database with its tables and fields, change its structure, query rows (a count, a total, or the rows themselves), add or change up to 500 rows in one call with a preview first, import a spreadsheet, and make a download. Deleted rows and tables wait in the trash. Every call follows the person's own access, including table rules about who sees which rows.
The live list
searchTools with category: "databases" for the current list of these tools with every input. This page is the readable copy.The tools
Every tool below keeps to the access of the key or sign-in that calls it, and to the person’s own role. A tool only sees the tools it may use.
createDatabase
Create a database, with its tables and fields in one call.
deleteDatabase
Move a whole database, one of its tables (pass table) or one of its dashboards (pass dashboard) to the trash.
deleteDatabaseRows
Move rows of a table to the trash: up to 500 by id, or every row that matches.
exportDatabaseRows
A table's rows as a file to download: CSV, or xlsx for Excel.
getDashboardImage
Draw one page of a database dashboard as a picture so you can SEE it, as getDiagramImage does for a diagram: every visual at its place on the whole page, however tall, with the numbers as you would…
getDashboardVisualGuide
How to write the spec of one kind of dashboard visual: its wells (what goes where, and how many), which must be filled, the summaries a value can use, its settings with their usual values, and a wo…
getDatabase
Read a database's structure: its tables, each table's fields and saved views, the rule that decides who sees which rows, and your access.
getDatabaseGuide
How to use the database tools, one topic at a time: filters and operators, totals and analytics, formulas, changing or deleting every row that matches, joins, copying, field types and type changes,…
getDatabaseRow
Read one row in full: every field including long text, linked rows (with their ids), people (with their ids) and attachments, plus who created and last changed it, its version, and who it is shared…
importDatabaseRows
Load a CSV, TSV or Excel file into a table: an existing table, or a new one (newTable) whose fields are made from the file's columns.
listDashboardVisualTypes
List the kinds of visual a database dashboard can hold: cards and KPIs, gauges, bar, column, line, area and combo charts, pie and donut, treemap, funnel, waterfall, scatter, heat map, table, matrix…
listDatabases
List the databases you can use, with their tables and row counts.
queryDatabaseRows
Answer a question about a table's rows in one call: a count, a total or an average, or the rows themselves.
saveDatabaseDashboard
Make a dashboard for a database, or change one, in one call that saves everything or nothing.
saveDatabaseForm
Make a form on a database table, or change one, in one call.
updateDatabase
Change a database: rename it, change its description or icon, switch inheriting access from its project, workspace or organisation on or off (inherit), let every member write to an organisation dat…
writeDatabaseRows
Add rows to a table or change rows, in one of two ways that never mix.