#gat-cdc

This application is not yet built and is under active development. It cannot even be used in its current state. The contents below are really just the beginnings of Readme Driven Development (RDD).

gat-cdc is a Change Data Capture (CDC) framework that is primarily trigger based. The goal for gat-cdc is to provide fast, easy to configure CDC database facilities on several different vendors including SQL Server, MySQL, PostgreSQL, and Oracle.

gat-cdc provides a common command line interface to manage gat-cdc projects within databases. Successful executions return an exit code of 0 whereas failures return an exit code of 1.

gat-cdc [options] [action]

Options:

• -project, -p XML_FILE - The gat-cdc XML project file to use. This is required for several actions. This cannot be provided in conjunction with the -project-name option.
• -project-name, -n PROJECT_NAME - The gat-cdc project name to use. This is required for several actions. This cannot be provided in conjunction with the -project option.
• -conditional, -c CONDITIONAL_NAME - The name of the conditional in the referenced project. Some actions use this to narrow queries.
• -db-vendor, -dbv VENDOR - The vendor for the database. This can be "mssql", "mysql", "postgres", or "oracle".
• -db-host, -dbh HOST - The hostname or IP address of the database.
• -db-port, -dbp PORT - The port the database listens on. If this is not provided, default ports will be used. This is 1433 for SQL Server, 3306 for MySQL, 5432 for PostgreSQL, and 1521 for Oracle.
• -db-name, -dbn NAME - The name of the database. If not provided, the default database will be used.
• -db-user, -dbu USERNAME - The username for the database. If this is not provided, anonymous access will be assumed unless it's SQL Server. If it's SQL server, the currently logged in user's domain credentials will be used.
• -db-pass, -dbp [PASSWORD] - The password for the database. If the option is given but the password is not, the user will be prompted to enter a masked password at runtime. This is required if -db-user is given.
• -oracle-server, -os SERVER_TYPE - The server type for an Oracle database. This can be "default", "dedicated", or "shared".
• -oracle-service-name, -osn SERVICE_NAME - The service name for an Oracle database. This cannot be used in conjunction with -oracle-service-identifier.
• -oracle-service-identifier, -osi SID_NAME - The SID for an Oracle database. This cannot be used in conjunction with -oracle-service-name.
• -strict, -s - If set, this will do more strict checking on validations, installations, and updates. Currently, this will perform the following additional assertions: ** Every conditional must have at least one applicable table

Action:

• -install, -i - Installs the given project XML into the database. This will fail if a project with the same name is already installed; use -update instead.
• -update, -ud - Updates the given project XML or name in the database. If the XML file for the project is provided, this essentially does an atomic -uninstall followed by a -install. If the name of the project is provided, it simply updates the conditionals from the last known project XML specification. When only a name of a project is provided, no externally referenced source files or assemblies will be updated. This will fail if the project does not currently exist in the database.
• -uninstall, -u - Uninstalls the given project in the database. This takes either a project XML file or a project name. This will fail if the project does not currently exit in the database.
• -validate, -v - Validates the given project XML file. Errors are returned one per line. This will do more advanced validation if database information is provided.
• -list-projects, -lp - Lists all known projects in the given database, one per line. This does not accept a project XML file or project name. If no projects are present, nothing is returned.
• -list-conditionals, -lc - Lists all conditionals for a given project name in the given database.
• -dump-project, -dp - Dumps the complete XML for the given project name in the given database as it was given when installed or updated. Note, the indentation may not be exactly as it was when initially installed or updated.
• -dump-conditional, -dc - Dumps the complete conditional XML for the given project name and conditional name in the given database as it was given when installed or updated. Note, the indentation may not be exactly as it was when initially installed or updated.
• -list-applied-schemas, -las - Lists every schema the given project applies to in the given database. If a project XML file is provided, this will list every schema this will apply to if it is installed or updated. If a project's name is provided, this will list every schema the project is currently applied to. A conditional name can be provided to narrow the results. The output is a schema name per line. They are returned in alphabetical order.
• -list-applied-tables, -lat - Lists every table the given project applies to in the given database. If a project XML file is provided, this will list every table this will apply to if it is installed or updated. If a project's name is provided, this will list every table the project is currently applied to. A conditional name can be provided to narrow the results. The output is a table name per line in the format SCHEMA.TABLE_NAME. They are returned in alphabetical order.
• -list-applied-columns, -lac - Lists every column the given project applies to in the given database. If a project XML file is provided, this will list every column this will apply to if it is installed or updated. If a project's name is provided, this will list every column the project is currently applied to. A conditional name can be provided to narrow the results. The output is a column name per line in the format SCHEMA.TABLE_NAME.COLUMN. The order of the schema and table output is alphabetical by name, and the order of the resulting columns is the order they are defined in the table.