Note¶

Purpose¶

Provides a user-defined note or comment about the INT file. This token is for documentation and metadata purposes only and is ignored by the BTR2SQL engine. It is useful for communicating migration notes, special instructions, or file history to other users or administrators. Multiple NOTE tokens can be used in the same INT file to provide additional information.

Parameters¶

String value

Default¶

Empty string if not specified

Example¶

Using the Staff Table from the movie rental database as an example:

CREATED Wed Dec 18 10:49:43 2024 by SQLBTR 7.0.10583.0
NOTE Data was migrated from the central database by RJM
DRIVER_NAME SQL_BTR
PERMANENT_INT NO
TABLE_NAME STAFF
FILEGROUP_TABLE
FILEGROUP_INDEX
FILEGROUP_TEXT
TRIM_STRING_FIELDS 1
USE_SQL_LOBS 0

Detailed Description¶

• Use this token to document important details, migration notes, or special handling instructions for the table. It is especially helpful in environments with many INT files or complex migration projects.

• Best Practice: Include migration batch numbers, responsible personnel, or links to related documentation for future reference.