Binary Scanning via Command Line (SQL)

Important

When running a locally installed agent, you must open the command line as an Administrator.

You must use credentials that can read metadata about the databases being scanned.

Analyze a relational database

analyze -a yourApp -c jdbc:postgresql://localhost:5432/sampledb -u postgres_user -pwd postgres_password

Help options for the Codelogic SQL Agent

codelogic-sql:>help analyze  

NAME
    analyze - Analyze a database by the given connection.

SYNOPSYS
    analyze [-c] string  [[-u] string]  [[-pwd] string]  [[-o] string]  [-a] string  [[-d] string]  [-e]  [[-s] string]  

OPTIONS
    -c or --jdbc-url  string
        The jdbc connection url, with no extra parameters, to use to connect to the database.
        [Mandatory]

    -u or --user  string
        The user to use while connecting to the database. It is recommended to provide a user with read-only permissions.
        [Optional, default = <none>]

    -pwd or --password  string
        The password for the given user.
        [Optional, default = <none>]

    -o or --output  string
        'API_CSV' - Batch data locally in CSV. Upload to api as single batch.
        'CSV' - write results to CSV files in the auxiliary directory. Zip the results once finished.
        [Optional, default = API_CSV]

    -a or --application  string
        The Application node to create that will be the parent of all objects found in the scan.
        The value is a comma separated list of 'Application' semantic names.
        Semantic names may be anything you wish if creating a new application.
        If linking grouping to an existing application, the semantic name is its 'identity' minus the 'grouping:' prefix.
        Identities for items may be found in the 'Item Details' page of the CodeLogic UI.
        [Mandatory]

    -d or --database  string
        This will override the detected database name.
        This is also useful if the name could not be determined.
        It is necessary to set this if your are scanning an Oracle database.
        [Optional, default = <none>]

    -e or --expunge-scan-sessions
        Instruct the server to delete all other scan sessions created
        by this agent and its configuration after the current scan
        session has completed successfully.
        [Optional, default = false]

    -s or --scan-space-name  string
        The name of the scan space that the data will be saved to.
        If specified, a ScanSpace with this name will be created if not found.
        If not specified, information will be saved to the default ScanSpace.
        [Optional, default = <none>]