Specific Options Switches

/project

Alias:

/pr

Arguments:

/project:file_name

Required:

-

Default:

-

Description:

Project file path.

See Also:

Project Wizard.

Example:

ApexSQLClean ... /project:Project.axcl ...

/includes

Alias:

/i

Arguments:

/includes:file_name

Required:

-

Default:

-

Description:

Selection profile path, profile format depends on scripting mode (all objects if omitted).

See Also:

Selection Profiles.

Example:

ApexSQLClean ... /includes:SelectionProfile.axlp ...

/file_dir

Alias:

/fd

Arguments:

/file_dir:directory_name

Required:

-

Default:

-

Description:

Directory for searching files.

See Also:

File Folder.

Example:

ApexSQLClean ... /file_dir:"c:\myprog" ...

/include_subdir

Alias:

/is

Arguments:

-

Required:

-

Default:

-

Description:

Includes subdirectory for files search. "/include_subdir" specified along with "/file_dir" switch.

See Also:

File SubFolder.

Example:

ApexSQLClean ... /include_subdir ...

/object_types

Alias:

/o

Arguments:

/object_types:[object type constant]

Required:

-

Default:

All object types.

Description:

Bitwise set of object type constants.

See Also:

Object Types.

Example:

ApexSQLClean ... /o:65 ...

/include

Alias:

/inc

Arguments:

/include:bitwise_constant:regular_expression

Required:

-

Default:

-

Description:

Include specific objects in processing, objects can be specified by first specifying object type (bitwise) and after ":" a regular expression. Multiple includes can be specified with spaces in between.

See Also:

Include Objects.

Example:

ApexSQLClean ... /inc:8:sales ...

/exclude

Alias:

/exc

Arguments:

/exclude:bitwise_constant:regular_expression

Required:

-

Default:

-

Description:

Exclude specific objects in processing, objects can be specified by first specifying object type (bitwise) and after ":" a regular expression. Multiple excludes can be specified with spaces in between. Exclude is processed after /include (if it is specified).

See Also:

Exclude Objects.

Example:

ApexSQLClean ... /exc:16:product ...

/external_databases

Alias:

/ex

Arguments:

/external_databases:database name

Required:

-

Default:

-

Description:

Databases for analysis of external references. Use spaces to separate multiple databases.

See Also:

External Databases.

Example:

ApexSQLClean ... /ex:test2 ...

/filename_patterns

Alias:

/fp

Arguments:

/filename_patterns:filename pattern

Required:

-

Default:

-

Description:

File name patterns, used in File Analysis for references. Use spaces to separate multiple patterns.

See Also:

Filename Patterns.

Example:

ApexSQLClean ... /fp:*.vb ...

/comment_delimiters

Alias:

/cd

Arguments:

/comment_delimiters:comments delimiters

Required:

-

Default:

-

Description:

Comment delimiters associated with the client program for file analysis. Use ":" to specify a multi-line comment (for example: "/*:*/"), and space to separate multiple comments. If a comment after the first one starts with "/", it should be specified as starting with "//" (this does not apply to the first comment specified after ":"). Place comment delimiters inside quotation marks.

See Also:

Comment Delimiters.

Example:

ApexSQLClean ... /cd:"/*:*/" ...

/search_settings

Alias:

/ss

Arguments:

/search_settings:w|t|c|n|d

Required:

-

Default:

-

Description:

Search settings used in File Analysis.

WholeWordSearch [w] - match whole word only

IgnoreTrigger [t] - ignore trigger reference to parent table

CaseSensitive [c] - search for SQL objects is case sensitive

None [n] - don't apply any search settings

Default [d] -use application defaults

Arguments can be combined.

See Also:

Search Settings.

Example:

ApexSQLClean ... /ss:w c ...

/report_options

Alias:

/ro

Arguments:

/report_options:ic|ip|ilp|io|icc|icp|icd|icf|d|n

Required:

-

Default:

-

Description:

Report options:

IncludeChildren [ic] - include children objects

IncludeParents [ip] - include parents objects

IncludeColumnLevelDependecies [ilp] - include column level dependencies

IncludeOwners [io] - include owner

IncludeCountOfChildren [icc] - include count of children

IncludeCountOfParents [icp] - include count of parents

IncludeCountOfDatabaseReferences [icd] - include count of database references

IncludeCountOfFileReferences [icf] - include count of file references

Default [d] - Default

None [n] - None

Arguments can be combined.

See Also:

Report Options.

Example:

ApexSQLClean ... /ro:icf ...

/script_options

Alias:

/so

Arguments:

/script_options:hdr|cmt|prt|trn|n|d

Required:

-

Default:

-

Description:

Optional Script elements:

IncludeHeader [hdr] - include script header

IncludeComments [cmt] - include comments

InclidePrint [prt] - include print statements

IncludeTransactionHandling [trn] - include transaction handling

None [n] - None

Default [d] - Default

Arguments can be combined.

See Also:

Script Format.

Example:

ApexSQLClean ... /so:cmt ...

/backup

Alias:

/bu

Arguments:

/backup:Default|None|"file path"

Required:

-

Default:

-

Description:

User's backup path or one of the following options:

Default - sets default value.

None - sets value to none.

See Also:

Altered Database Backup.

Example:

ApexSQLClean ... /bu:Default ...