fastbcp_preview_export
Preview a FastBCP export command without executing it. Shows the exact CLI command with passwords masked and auto-suggests parallelism method based on source database.
Instructions
Build and preview a FastBCP export command WITHOUT executing it. Shows the exact CLI command with passwords masked. If no parallelism method is specified, one is auto-suggested based on the source database type. Does NOT test connectivity or execute the export. After reviewing, pass the command to fastbcp_execute_export.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| output | Yes | ||
| source | Yes | ||
| options | No | ||
| os_type | No | Target operating system for command formatting | linux |
| config_file | No | Path to a YAML configuration file (--config parameter, requires FastBCP 0.30+) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tips | No | Suggested next tool calls to resolve errors. | |
| errors | No | Field-level validation errors (status='error'). | |
| status | Yes | 'ok' when the call succeeded; 'error' when the parameters failed validation or execution failed. | |
| command | No | Full CLI argv with real credentials, ready to hand to the execute tool. | |
| warnings | No | Version-compatibility warnings. | |
| explanation | No | Human-readable summary of what the command does. | |
| preview_only | No | True when no binary is configured (execution unavailable). | |
| command_string | No | The argv joined into one command string (real credentials). | |
| command_display | No | The command with passwords masked, safe to show the user. | |
| auto_parallelism | No | Parallelism method auto-suggested when none was given. |