When embedding Flatfile, this plugin should be deployed in a server-side listener. Learn more

@flatfile/plugin-convert-sql-ddl

The @flatfile/plugin-convert-sql-ddl plugin will automatically convert SQL DDL to the Flatfile Blueprint, a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation.



Event Type:


listener.on('space:configure')

​
Overview

This plugin will automatically convert SQL DDL to the Flatfile Blueprint, a powerful DDL (Data Definition Language) created by Flatfile with a focus on validation and data preparation.

​
Parameters

setupFactory
SqlSetupFactory
required

The setupFactory parameter holds the Workbook and Sheet configuration options and SQL DDL source.

callback
function

The callback parameter receives three arguments: event, workbookIds, and a tick function. The tick function can be used to update the Job’s progress. The callback function is invoked once the Space and Workbooks are fully configured.

​
API Calls

  • api.spaces.update
  • api.workbooks.create

​
Imported NPM Packages

​
Usage

The @flatfile/plugin-convert-sql-ddl plugin simplifies the setup of new Flatfile Spaces by configuring the Space from a provided SQL DDL. Designed for server-side listeners, it auto-configures the Space using the supplied settings.

install
npm i @flatfile/plugin-convert-sql-ddl
import
import { configureSpaceWithSqlDDL } from "@flatfile/plugin-convert-sql-ddl";
listener.js
listener.use(
  configureSpaceWithSqlDDL({
    workbooks: [
      {
        name: "SQL DDL Generated Workbook",
        source: "src/data/example.sql",
        sheets: [
          {
            name: "Users",
            slug: "user",
          },
          {
            name: "Products",
            slug: "products",
          },
          {
            name: "Locations",
            slug: "locations",
          },
        ],
      },
    ],
  })
);

​
See the code

@flatfile/plugin-convert-sql-ddl

@flatfile/plugin-convert-yaml-schema@flatfile/plugin-convert-openapi-schema