Database Schema Importer

Imports a database table schema and generates Grooper data fields or columns corresponding to the table's column definitions.

Remarks

The Database Schema Importer is a schema importer that connects to a specified database and reads the schema for a given table or view. It automatically generates Data Field or Data Column objects in a Data Model, Data Section, or Data Table to match the columns found in the external database table.

Purpose

This importer streamlines the process of mapping database tables to Grooper data models, reducing manual configuration and ensuring consistency between the database schema and the extracted data structure.

How It Works

• The user selects a Data Connection and specifies the name of a table or view.
• When executed, the importer connects to the database, retrieves the column definitions for the specified table, and creates a corresponding Data Field or Data Column for each column.
• The data type and alignment of each field are determined automatically based on the database column's type.

Configuration Guidance

• Set the 'Data Connection' property to reference the database you wish to import from.
• Set the 'Database Table' property to the name of the table or view whose schema you want to import.
• The importer can be used in Data Model, Data Section, or Data Table containers.

Usage Notes

• Database Schema Importer is typically used during initial data model setup or when synchronizing Grooper data models with changes in the external database schema.
• After import, you may further customize the generated fields as needed.
• For more information, see Schema Importer, Data Connection, and Data Field Container.

Properties

Name	Type		Description
Data Connection	Data Connection	►	The database connection to be used for schema import. EditorNode Reference Editor Requiredtrue This property specifies the Data Connection object that defines how to connect to the external database. The connection must be configured and tested before use. Only tables and views accessible through this connection will be available for import. Configuration Guidance Select or create a Data Connection in your Grooper repository. Ensure the connection has appropriate permissions to read schema information. Usage Notes Changing the data connection may affect the available tables and the results of schema import. For more information, see Data Connection documentation.
Database Table	String	►	The name of the table or view to generate fields for. EditorTable Name Editor Requiredtrue This property specifies the name of the database table or view whose schema will be imported. The list of available tables is determined by the selected Data Connection. The importer will generate a Data Field or Data Column for each column in the specified table or view. Configuration Guidance Use the table name editor to select from available tables or views. Ensure the table exists and is accessible via the configured connection. Usage Notes Changing the table name will update the set of fields generated on the next import. For more information, see Data Connection and Schema Importer documentation.

See Also

Data Connection

Used By

Data Field Container - Import Schema