ncloud_datacatalog_create_scanner
Create a scanner that registers Object Storage, Iceberg, or Cloud DB/JDBC data sources as queryable catalog tables. Use dryRun to preview first, then run manually or schedule with CRON.
Instructions
Create a scanner that registers a data source as catalog tables — the standard path for exposing Object Storage or Iceberg data (and Cloud DB / JDBC sources) as queryable tables. Creating a scanner does not scan: run it with ncloud_datacatalog_run_scanner (or set scheduleType=CRON). Use dryRun=true to preview without creating.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Scanner name | |
| type | Yes | Data source type. OBJECT_STORAGE / ICEBERG require location; the Cloud DB types and JDBC require connectionId | |
| dryRun | No | If true, returns a preview without actually creating the scanner | |
| location | No | Scan path (e.g. 's3a://mybucket/test/'). REQUIRED when type is OBJECT_STORAGE or ICEBERG | |
| schedule | No | Cron expression (e.g. '1 0 * * *'). REQUIRED when scheduleType is CRON | |
| catalogId | Yes | Catalog ID (from getCatalogs) | |
| opAddType | Yes | How to update an existing table when the source schema gains columns. ADD_NEW_COLUMNS_ONLY: add new columns only, UPDATE_TABLE: update the table definition, IGNORE_UPDATE: ignore | |
| opDelType | No | How to update an existing table when source columns disappear. DEL_NO: ignore | |
| description | No | Scanner description | |
| connectionId | No | Connection ID (see ncloud_datacatalog_get_connections). REQUIRED when type is a Cloud DB type or JDBC | |
| databaseName | Yes | Output database name — where the scanned tables are created | |
| isMergeForce | No | Force table merging | |
| scheduleType | Yes | Run schedule. ON_DEMAND: only when requested, CRON: on a cron schedule (schedule is then required) | |
| excludePattern | No | Exclude pattern (e.g. '*.csv') | |
| includePattern | No | Include pattern (e.g. '*.xml') | |
| tablePrefixName | No | Prefix for the created table names | |
| scanFileLimitCnt | No | Scan only this many files, 1-100. Omit to scan everything. OBJECT_STORAGE only | |
| maxTableThreshold | No | Maximum number of tables the scanner may create | |
| isUseHivePartitionOnly | No | Recognize Hive-style partitions only |