check

This command runs a static code analysis using a configuration that is defined in the Web GUI. This feature is only available with an Essential or Professional Subscription.

Syntax

dblinter [<options>] check [<args>]

Options

See Options. Mandatory options are tenantName, userName, accessToken and configName.

Argument Syntax

in Command Line
in Property File

--<argument>=<value>

<argument>=<value>

Arguments

It is not possible to set arguments using environment variables. Beside that, in dbLinter, both arguments and options are treated in the same way. Therefore, they can be used in any order. For example, they can be used before or after the command name. We use options when the semantics are identical for each applicable command. Arguments are used when the semantics change for a command.

outputFormats
A comma-separated list of the output formats to be produced. All formats are considered by default. The following formats are supported:
- vscode: dbLinter Check Report as Markdown for VS Code. This report will open automatically when the analysis is run via the VS Code extension.
- sonarqube: SonarQube Generic formatted issue report to import issues in any SonarQube edition without any plugin.
- sarif: Static Analysis Results Interchange Format (SARIF) to visualise issues in various tools. See also Viewers.
- checkstyle: Checkstyle XML report.
- github: Workflow commands for GitHub Actions. These commands (annotations) are interpreted when printed to stdout.
- gitlab: GitLab quality report.
outputName
This is the relative path from the working directory to the base name of the output files. Missing target directories will be created. For example, if you use the name check for an outputName, a file called check.vscode.md will be created in the working directory. The default is dblinter.
parallel
The number of files analysed in parallel. The default is 1. To achieve better performance with higher values, you need enough free system resources. Also consider increasing the maximum heap space using the JAVA_OPTS environment variable. For example, export JAVA_OPTS=-Xmx=32G to set the maximum heap size to 32GB. The default maximum heap size for a system with 64 GB of RAM is 16 GB (one quarter), which is sensible for desktop systems. In CI/CD environments, however, higher values can improve performance, especially when processing large files.

Example

dbLinter check \
    --tenantName=Demo \
    --userName=philipp.salvisberg+42@gmail.com \
    --accessToken=*** \
    --configName=Default \
    --outputFormats=vscode,github \
    --outputName=check \
    --parallel=2

The console output for the dbLinter-Demo project on GitHub looks like this:

Using connection to jdbc:oracle:thin:@localhost:1521/freepdb1 with user DBL_READ
Processed examples/Core-G-1010.sql (1/184) in 0.125 sec. Found 4 issues.
Processed examples/Core-G-1020.sql (2/184) in 0.394 sec. Found 8 issues.
Processed examples/Core-G-1030.sql (3/184) in 0.291 sec. Found 2 issues.
Processed examples/Core-G-1050.sql (4/184) in 0.021 sec. Found 2 issues.
Processed examples/Core-G-1060.sql (5/184) in 0.010 sec. Found 2 issues.
Processed examples/Core-G-1070.sql (6/184) in 0.004 sec. Found 2 issues.
Processed examples/Core-G-1080.sql (7/184) in 0.043 sec. Found 1 issues.
Processed examples/Core-G-1110.sql (8/184) in 0.021 sec. Found 2 issues.
Processed examples/Core-G-1120.sql (9/184) in 0.003 sec.
Processed examples/Core-G-1130.sql (10/184) in 0.003 sec.
Processed examples/Core-G-1140.sql (11/184) in 0.001 sec.
Processed examples/Core-G-1150.sql (12/184) in 0.001 sec.
Processed examples/Core-G-1210.sql (13/184) in 0.023 sec.
Processed examples/Core-G-1040.sql (14/184) in 0.172 sec. Found 8 issues.
Processed examples/Core-G-1220.sql (15/184) in 0.050 sec.
Processed examples/Core-G-1230.sql (16/184) in 0.095 sec. Found 2 issues.
Processed examples/Core-G-1240.sql (17/184) in 0.063 sec. Found 2 issues.
Processed examples/Core-G-1260.sql (18/184) in 0.013 sec. Found 1 issues.
Processed examples/Core-G-1250.sql (19/184) in 0.024 sec. Found 2 issues.
Processed examples/Core-G-1270.sql (20/184) in 0.011 sec. Found 1 issues.
Processed examples/Core-G-1310.sql (21/184) in 0.005 sec. Found 1 issues.
Processed examples/Core-G-1280.sql (22/184) in 0.009 sec. Found 1 issues.
Processed examples/Core-G-1920.sql (23/184) in 0.003 sec. Found 1 issues.
Processed examples/Core-G-1910.sql (24/184) in 0.014 sec. Found 1 issues.
Processed examples/Core-G-2110.sql (25/184) in 0.014 sec.
Processed examples/Core-G-2120.sql (26/184) in 0.017 sec.
Processed examples/Core-G-2130.sql (27/184) in 0.012 sec.
Processed examples/Core-G-2140.sql (28/184) in 0.009 sec. Found 2 issues.
Processed examples/Core-G-2135.sql (29/184) in 0.038 sec. Found 1 issues.
Processed examples/Core-G-2150.sql (30/184) in 0.013 sec. Found 1 issues.
Processed examples/Core-G-2145.sql (31/184) in 0.047 sec. Found 1 issues.
Processed examples/Core-G-2160.sql (32/184) in 0.029 sec. Found 2 issues.
Processed examples/Core-G-2180.sql (33/184) in 0.009 sec. Found 10 issues.
Processed examples/Core-G-2185.sql (34/184) in 0.005 sec. Found 2 issues.
Processed examples/Core-G-2170.sql (35/184) in 0.046 sec. Found 2 issues.
Processed examples/Core-G-2190.sql (36/184) in 0.022 sec. Found 1 issues.
Processed examples/Core-G-2210.sql (37/184) in 0.013 sec. Found 1 issues.
Processed examples/Core-G-2220.sql (38/184) in 0.027 sec. Found 2 issues.
Processed examples/Core-G-2230.sql (39/184) in 0.027 sec. Found 2 issues.
Processed examples/Core-G-2320.sql (40/184) in 0.025 sec. Found 1 issues.
Processed examples/Core-G-2310.sql (41/184) in 0.026 sec. Found 1 issues.
Processed examples/Core-G-2330.sql (42/184) in 0.004 sec. Found 1 issues.
Processed examples/Core-G-2410.sql (43/184) in 0.005 sec. Found 1 issues.
Processed examples/Core-G-2340.sql (44/184) in 0.010 sec. Found 1 issues.
Processed examples/Core-G-2610.sql (45/184) in 0.012 sec. Found 1 issues.
Processed examples/Core-G-2510.sql (46/184) in 0.033 sec. Found 2 issues.
Processed examples/Core-G-3115.sql (47/184) in 0.003 sec. Found 1 issues.
Processed examples/Core-G-3110.sql (48/184) in 0.027 sec. Found 1 issues.
Processed examples/Core-G-3120.sql (49/184) in 0.041 sec. Found 3 issues.
Processed examples/Core-G-3130.sql (50/184) in 0.038 sec. Found 1 issues.
Processed examples/Core-G-3140.sql (51/184) in 0.036 sec. Found 2 issues.
Processed examples/Core-G-3145.sql (52/184) in 0.037 sec. Found 1 issues.
Processed examples/Core-G-3160.sql (53/184) in 0.016 sec.
Processed examples/Core-G-3150.sql (54/184) in 0.047 sec. Found 1 issues.
Processed examples/Core-G-3170.sql (55/184) in 0.034 sec. Found 1 issues.
Processed examples/Core-G-3182.sql (56/184) in 0.022 sec. Found 1 issues.
Processed examples/Core-G-3180.sql (57/184) in 0.041 sec. Found 3 issues.
Processed examples/Core-G-3185.sql (58/184) in 0.003 sec. Found 2 issues.
Processed examples/Core-G-3183.sql (59/184) in 0.018 sec. Found 1 issues.
Processed examples/Core-G-3190.sql (60/184) in 0.003 sec. Found 1 issues.
Processed examples/Core-G-3195.sql (61/184) in 0.009 sec. Found 1 issues.
Processed examples/Core-G-3220.sql (62/184) in 0.038 sec. Found 1 issues.
Processed examples/Core-G-3210.sql (63/184) in 0.049 sec. Found 1 issues.
Processed examples/Core-G-3320.sql (64/184) in 0.037 sec. Found 3 issues.
Processed examples/Core-G-3330.sql (65/184) in 0.012 sec. Found 1 issues.
Processed examples/Core-G-3310.sql (66/184) in 0.059 sec. Found 2 issues.
Processed examples/Core-G-4120.sql (67/184) in 0.034 sec. Found 3 issues.
Processed examples/Core-G-4110.sql (68/184) in 0.054 sec. Found 3 issues.
Processed examples/Core-G-4130.sql (69/184) in 0.036 sec. Found 1 issues.
Processed examples/Core-G-4210.sql (70/184) in 0.017 sec. Found 1 issues.
Processed examples/Core-G-4140.sql (71/184) in 0.055 sec. Found 2 issues.
Processed examples/Core-G-4220.sql (72/184) in 0.030 sec. Found 1 issues.
Processed examples/Core-G-4230.sql (73/184) in 0.040 sec. Found 1 issues.
Processed examples/Core-G-4250.sql (74/184) in 0.022 sec. Found 1 issues.
Processed examples/Core-G-4240.sql (75/184) in 0.050 sec. Found 1 issues.
Processed examples/Core-G-4270.sql (76/184) in 0.015 sec. Found 1 issues.
Processed examples/Core-G-4260.sql (77/184) in 0.018 sec. Found 1 issues.
Processed examples/Core-G-4320.sql (78/184) in 0.028 sec. Found 12 issues.
Processed examples/Core-G-4325.sql (79/184) in 0.006 sec. Found 2 issues.
Processed examples/Core-G-4330.sql (80/184) in 0.007 sec. Found 2 issues.
Processed examples/Core-G-4310.sql (81/184) in 0.052 sec. Found 1 issues.
Processed examples/Core-G-4340.sql (82/184) in 0.050 sec. Found 2 issues.
Processed examples/Core-G-4350.sql (83/184) in 0.062 sec. Found 2 issues.
Processed examples/Core-G-4365.sql (84/184) in 0.004 sec. Found 1 issues.
Processed examples/Core-G-4360.sql (85/184) in 0.029 sec. Found 2 issues.
Processed examples/Core-G-4375.sql (86/184) in 0.008 sec. Found 2 issues.
Processed examples/Core-G-4370.sql (87/184) in 0.019 sec. Found 4 issues.
Processed examples/Core-G-4385.sql (88/184) in 0.003 sec. Found 1 issues.
Processed examples/Core-G-4380.sql (89/184) in 0.021 sec. Found 3 issues.
Processed examples/Core-G-4387.sql (90/184) in 0.011 sec. Found 1 issues.
Processed examples/Core-G-4395.sql (91/184) in 0.005 sec. Found 3 issues.
Processed examples/Core-G-5010.sql (92/184) in 0.010 sec. Found 2 issues.
Processed examples/Core-G-4390.sql (93/184) in 0.019 sec. Found 2 issues.
Processed examples/Core-G-5020.sql (94/184) in 0.006 sec. Found 1 issues.
Processed examples/Core-G-5040.sql (95/184) in 0.004 sec. Found 1 issues.
Processed examples/Core-G-5050.sql (96/184) in 0.016 sec. Found 1 issues.
Processed examples/Core-G-5030.sql (97/184) in 0.034 sec. Found 4 issues.
Processed examples/Core-G-5070.sql (98/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-5060.sql (99/184) in 0.021 sec. Found 1 issues.
Processed examples/Core-G-6010.sql (100/184) in 0.011 sec. Found 1 issues.
Processed examples/Core-G-5080.sql (101/184) in 0.041 sec. Found 1 issues.
Processed examples/Core-G-7110.sql (102/184) in 0.015 sec. Found 2 issues.
Processed examples/Core-G-7120.sql (103/184) in 0.023 sec. Found 2 issues.
Processed examples/Core-G-7125.sql (104/184) in 0.005 sec. Found 1 issues.
Processed examples/Core-G-6020.sql (105/184) in 0.095 sec. Found 1 issues.
Processed examples/Core-G-7140.sql (106/184) in 0.006 sec. Found 1 issues.
Processed examples/Core-G-7150.sql (107/184) in 0.017 sec. Found 1 issues.
Processed examples/Core-G-7130.sql (108/184) in 0.055 sec. Found 4 issues.
Processed examples/Core-G-7160.sql (109/184) in 0.025 sec. Found 4 issues.
Processed examples/Core-G-7180.sql (110/184) in 0.008 sec. Found 1 issues.
Processed examples/Core-G-7170.sql (111/184) in 0.033 sec. Found 4 issues.
Processed examples/Core-G-7220.sql (112/184) in 0.035 sec. Found 1 issues.
Processed examples/Core-G-7230.sql (113/184) in 0.109 sec. Found 1 issues.
Processed examples/Core-G-7310.sql (114/184) in 0.004 sec. Found 1 issues.
Processed examples/Core-G-7320.sql (115/184) in 0.014 sec. Found 1 issues.
Processed examples/Core-G-7330.sql (116/184) in 0.006 sec. Found 3 issues.
Processed examples/Core-G-7410.sql (117/184) in 0.004 sec. Found 1 issues.
Processed examples/Core-G-7420.sql (118/184) in 0.004 sec. Found 1 issues.
Processed examples/Core-G-7430.sql (119/184) in 0.005 sec. Found 2 issues.
Processed examples/Core-G-7250.sql (120/184) in 0.123 sec. Found 2 issues.
Processed examples/Core-G-7450.sql (121/184) in 0.003 sec. Found 1 issues.
Processed examples/Core-G-7440.sql (122/184) in 0.014 sec. Found 1 issues.
Processed examples/Core-G-7460.sql (123/184) in 0.002 sec.
Processed examples/Core-G-7510.sql (124/184) in 0.005 sec. Found 2 issues.
Processed examples/Core-G-7520.sql (125/184) in 0.010 sec. Found 1 issues.
Processed examples/Core-G-7720.sql (126/184) in 0.016 sec. Found 2 issues.
Processed examples/Core-G-7730.sql (127/184) in 0.004 sec. Found 1 issues.
Processed examples/Core-G-7740.sql (128/184) in 0.005 sec. Found 2 issues.
Processed examples/Core-G-7710.sql (129/184) in 0.032 sec. Found 1 issues.
Processed examples/Core-G-7910.sql (130/184) in 0.009 sec. Found 2 issues.
Processed examples/Core-G-7810.sql (131/184) in 0.013 sec. Found 1 issues.
Processed examples/Core-G-8120.sql (132/184) in 0.017 sec. Found 2 issues.
Processed examples/Core-G-8110.sql (133/184) in 0.033 sec. Found 1 issues.
Processed examples/Core-G-8210.sql (134/184) in 0.015 sec.
Processed examples/Core-G-8410.sql (135/184) in 0.033 sec. Found 2 issues.
Processed examples/Core-G-8310.sql (136/184) in 0.036 sec. Found 2 issues.
Processed examples/Core-G-8510.sql (137/184) in 0.013 sec. Found 1 issues.
Processed examples/Core-G-9010.sql (138/184) in 0.025 sec. Found 1 issues.
Processed examples/Core-G-9020.sql (139/184) in 0.012 sec. Found 1 issues.
Processed examples/Core-G-9040.sql (140/184) in 0.009 sec. Found 1 issues.
Processed examples/Core-G-9101.sql (141/184) in 0.002 sec. Found 2 issues.
Processed examples/Core-G-9102.sql (142/184) in 0.002 sec. Found 2 issues.
Processed examples/Core-G-9103.sql (143/184) in 0.002 sec. Found 2 issues.
Processed examples/Core-G-9030.sql (144/184) in 0.017 sec. Found 1 issues.
Processed examples/Core-G-9105.sql (145/184) in 0.004 sec. Found 9 issues.
Processed examples/Core-G-9106.sql (146/184) in 0.032 sec. Found 4 issues.
Processed examples/Core-G-9104.sql (147/184) in 0.038 sec. Found 5 issues.
Processed examples/Core-G-9108.sql (148/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-9109.sql (149/184) in 0.001 sec. Found 1 issues.
Processed examples/Core-G-9110.sql (150/184) in 0.001 sec. Found 1 issues.
Processed examples/Core-G-9107.sql (151/184) in 0.006 sec. Found 2 issues.
Processed examples/Core-G-9111.sql (152/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-9112.sql (153/184) in 0.002 sec. Found 3 issues.
Processed examples/Core-G-9113.sql (154/184) in 0.002 sec. Found 2 issues.
Processed examples/Core-G-9114.sql (155/184) in 0.002 sec. Found 2 issues.
Processed examples/Core-G-9115.sql (156/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-9116.sql (157/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-9202.sql (158/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-9201.sql (159/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-9203.sql (160/184) in 0.001 sec.
Processed examples/Core-G-9205.sql (161/184) in 0.003 sec. Found 1 issues.
Processed examples/Core-G-9204.sql (162/184) in 0.005 sec. Found 1 issues.
Processed examples/Core-G-9206.sql (163/184) in 0.009 sec. Found 2 issues.
Processed examples/Core-G-9207.sql (164/184) in 0.029 sec. Found 1 issues.
Processed examples/Core-G-9208.sql (165/184) in 0.028 sec. Found 1 issues.
Processed examples/Core-G-9209.sql (166/184) in 0.008 sec. Found 1 issues.
Processed examples/Core-G-9211.sql (167/184) in 0.001 sec.
Processed examples/Core-G-9212.sql (168/184) in 0.001 sec.
Processed examples/Core-G-9213.sql (169/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-9214.sql (170/184) in 0.001 sec. Found 2 issues.
Processed examples/Core-G-9215.sql (171/184) in 0.002 sec. Found 2 issues.
Processed examples/Core-G-9216.sql (172/184) in 0.002 sec. Found 2 issues.
Processed examples/Core-G-9217.sql (173/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-9218.sql (174/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-9219.sql (175/184) in 0.001 sec. Found 1 issues.
Processed examples/Core-G-9210.sql (176/184) in 0.025 sec. Found 1 issues.
Processed examples/Core-G-9600.sql (177/184) in 0.011 sec. Found 1 issues.
Processed examples/Core-G-9601.sql (178/184) in 0.004 sec. Found 3 issues.
Processed examples/Core-G-9501.sql (179/184) in 0.029 sec. Found 1 issues.
Processed examples/Core-G-9602.sql (180/184) in 0.005 sec. Found 3 issues.
Processed examples/Core-G-9604.sql (181/184) in 0.002 sec. Found 1 issues.
Processed examples/Core-G-9603.sql (182/184) in 0.004 sec. Found 3 issues.
Processed examples/Core-G-9605.sql (183/184) in 0.002 sec. Found 3 issues.
Processed install.sql (184/184) in 0.086 sec.
Check Summary
- Duration:                   2.320 sec.
- Files:                      184
- Characters:                 85,334
- Lines:                      3,144
- Lines of code:              2,137
- Statements:                 422
- PL/SQL units:               61
- Functions:                  61
- Comment line density:       9.0%
- Cyclomatic complexity (CC): 123
- Max CC per unit:            20
- Avg CC per unit:            2
- Errors:                     66
- Warnings:                   243
- Infos:                      0