Export

Summary

Transfer contents of Dendron to a table on Airtable

Features

Checkpointing

The pod maintains a checkpointing file to keep track of the latest file that has been successfully exported to Airtable.

Idempotency

This pod will check if a note has already been exported and not duplicate already exported notes

Requirements

  • the table must exist in Airtable
  • all columns that you want to write to must exist in Airtable
  • you must have a column named DendronId (case sensitive)

Side Effects

  • this pod will add airtableId in the frontmatter of your note

Configuration

apiKey

Airtable api key

baseId

base ID of Airtable base.

tableName

name of resulting table.

srcFieldMapping

Mapping of Airtable fields with the note. This can either be a plain string or a dictionary that specifics additional properties. You can see the type definition below

type SrcFieldMapping =
  | {
      to?: string;
      type: "string" | "date" | "singleTag";
      filter?: string;
    }

In all cases, the key represents the name of the column in Airtable.

  • NOTE: the key must exist in Airtable before you are able to create a new value

string value

String value is the name of the field in Dendron. You can use any valid NoteProps (Private) as the value

srcFieldMapping: {Note ID : id, Title : title, Summary: body}

srcHierarchy

The src .md file from where to start the sync

noCheckpointing

hen enabled, disables Export

Quickstart

  1. Create an Airtable table with fields (all fields are text fields)

    DendronIdTitleSummary
  2. Run Configure Pod, select airtable.export, and add the following configuration

    dest: workspace # eg. appGB8ES***
    tableName: Novels
    srcHierarchy: books
    apiKey: ***
    baseID: ***
    srcFieldMapping: {DendronId: id, Title : title, Summary: body}
    
  3. Create the following notes in your vault

    └── vault
        ├── books.harrypotter.md
        └── books.alchemist.md
    
  4. Run Export Pod and select airtable.export. You should get the following results on Airtable

    DendronIdTitleSummary
    04236d97-d45bHarrypotterHarry Potter, a boy who lives in the fictional town of Little Whinging, Surrey with his aunt, uncle, and cousin
    07736d97-d45bAlchemistThe Alchemist follows the journey of an Andalusian shepherd boy named Santiago. Believing a recurring dream to be prophetic, he asks a Gypsy fortune teller in the nearby town about its meaning

Backlinks