Page tree
Skip to end of metadata
Go to start of metadata

Target audience:

Users of the extension providing source code analysis support for SQL files.

Summary: This document provides basic information about the extension that provides source code analysis support for SQL files.

What's new:

  • New icon for DML script files
  • Renamed techonology from SQL Analyzer to SQL - this impacts the analysis process: you now need to tick the "SQL" option, rather than the "SQL Anlayzer" option when creating the Analysis Unit in the CAST Management Studio. See SQL Analyzer - 2.x - Packaging, delivering and analyzing your source code.
  • Errors and warnings documentation
  • New TCCSetup file
  • Added support for the following syntaxes :
    • ALTER TABLE ...  ADD CONSTRAINT ...  PRIMARY KEY USING INDEX 
    • ALTER TABLE ...  ADD CONSTRAINT ...  PRIMARY KEY (......)
    • CREATE EDITIONABLE PROCEDURE
  • Fixed OverflowError: Python int too large to convert to C long while analysing DB2ZOS script xxl values are >= 4294967295

Description

The SQL Analyzer (successor to the SQL Script extension) provides support for database technologies using the ANSI SQL-92 / 99 language. This extension uses the Universal Analyzer framework and is intended to analyse DDL, DML and SQL exports for a large variety of SQL variants:

  • This extension provides source code analysis support for DDL and DML*.sql files using an over language of the various sql variants.
  • This extension also accepts src and uaxDirectory files. Check here for more details about sqltablesize files.

In what situation should you install this extension?

  • If you need to analyze PostgreSQL, MySQL, MariaDB, SQLite and DB2
  • If your application contains schemas from database vendors not supported "out of the box" by CAST AIP (see http://doc.castsoftware.com, Supported Technologies for more information) but, which are compliant with ANSI SQL-92 / 99
  • When you do not have access to the online dabatase to perform an extraction for use with CAST AIP and have instead been provided with DDL scripts

Transitioning from from the CAST AIP DB2 Analyzer to the SQL Analyzer extension

If you have been actively analyzing DB2 (z/OS or UDB) with the DB2 Analyzer (provided out-of-the-box in CAST AIP) you can transition to using the SQL Analyzer extension to analyze your DB2 source code. The process of transitioning is described in How to transition from the CAST AIP DB2 Analyzer to the SQL Analyzer extension.

Reversed links

When transitioning from the DB2 Analyzer to the SQL Analyzer, links between Tables and Indexes, Foreign Keys, Primary Keys and Unique Keys will appear to be reversed when comparing the analysis results of the DB2 Analyzer and the SQL Analyzer. This is because the representation of links in the SQL Analyzer uses a different method (which is identical for all supported RDBMS) to the DB2 Analyzer.

Vendor compatibility matrix

Official support

Up to version 9.5Up to version 5.5Up to version 10.0Up to version 3.xUp to version 11.1 (UDB) and 12 (zOS)

Unofficial support

Unofficial support refers to CAST AIP features or official CAST AIP extensions that provide specific capabilities that have not been officially validated or tested by CAST, therefore CAST cannot guarantee the results they produce. An example of a feature in this category is the capability built into the SQL Analyzer extension to analyze Oracle, Microsoft SQL Server and Sybase ASE source code: while the analysis will work, results are not guaranteed.

Function Point, Quality and Sizing support

This extension provides the following support:

  • Function Points (transactions): a green tick indicates that OMG Function Point counting and Transaction Risk Index are supported
  • Quality and Sizing: a green tick indicates that CAST can measure size and that a minimum set of Quality Rules exist

Function Points
(transactions)

Quality and Sizing

(tick)(tick)

CAST AIP compatibility

This extension is compatible with:

CAST AIP releaseSupported
8.3.x(tick)
8.2.x(tick)
8.1.x(tick)
8.0.x(tick)
7.3.x(error)

Supported DBMS servers used for CAST AIP schemas

This extension is compatible with the following DBMS servers used to host CAST AIP schemas:

CAST AIP releaseCSS2OracleMicrosoft
All supported releases(tick)(tick)(tick)

Prerequisites

(tick)An installation of any compatible release of CAST AIP (see table above)

Download and installation instructions

Please see:

  • The latest release status of this extension can be seen when downloading it from the CAST Extend server.
  • Please see Known Limitations and Issues for information about an error that may occur when installing the extension if you have also already installed a very old and unsupported Universal Analyzer langage pack that conflicts with the SQL Analyzer.

Upgrade from the SQL Script extension

If you have previously used the SQL Script extension (com.castsoftware.sqlscript) on existing schemas, you should proceed as following:

  • In CAST Server Manager use the Manage Extensions option on the CAST AIP schemas in which the SQL Script extension is installed
  • Select Analyzer for SQL files and choose deactivate to remove the existing extension. No further actions are required.

Packaging, delivering and analyzing your source code

Please see: SQL Analyzer - 2.x - Packaging, delivering and analyzing your source code

What results can you expect?

Once the analysis/snapshot generation has completed, you can view the results in the normal manner (for example via CAST Enlighten) - click to enlarge:

You can also use the CAST Management Studio option View Analysis Unit Content to see the objects that have been created following the analysis:

Objects

The following objects are displayed in CAST Enlighten:

IconDescription

Schema

Table

View

Table Column

Index

Foreign Key

Unique Constraint

Procedure

Function

Trigger

Package 

Type

Event

Synonym

SQL Script

DDL Script File

DML Script

Note that:

  • Object identity is independent from the *.sql file the object comes from.
  • Object identity depends on the Analysis Unit's identity. Therefore, using a new Analysis Unit or deleting and then recreating an Analysis Unit will change the object's identity and will result in added/removed objects in the subsequent analysis results.
  • Typically a table will be identified by the Analysis Unit name, schema name and table name.
  • When no schema can be determined, the analyzer considers that a schema named "DEFAULT" is used. But generally, identifiers are qualified in CREATE TABLE statements.

Table deletion and renaming

DROP TABLE syntax is supported for table objects within the same file. When creating a table through CREATE TABLE tableName (colName int, ...) followed by a DROP TABLE tableName, the table will not be recorded and thus will not be displayed in CAST Enlighten. Similarly, if a table is renamed with a RENAME TABLE statement (or ALTER TABLE RENAME TO as in SQLite and PostgreSQL), this change will be reflected in CAST Enlighten. Presently we consider case-insensitive names, i.e., objects named tableName, TABLEname are considered to be the same object.

Links are created for transaction and function point needs.

DDL

You can expect the following links on the DDL side within the same sql file:

  • useSelect, useInsert, useUpdate, useDelete Links from Procedure / FunctionEvent  to Table / View
  • callLink from Procedure / Function / Event to Procedure / Function
  • useSelect from View to Table / View used in the query of the view
  • callLink from View to Function
  • relyonLink from Index to the Table
  • relyonLink from Index to the Column implied in the index
  • referLink from: 
    • Table / Table Column to a Table / Table Column referenced in a Foreign Key 
    •  from Synonym to Table / View / Function / Procedure / Package aliased by Synonym
  • callLink to the correct Trigger where the tables is accessed in insert/update/delete
    • example a Trigger declared as BEFORE INSERT on a table, any insert to that table will call the trigger...

DML

You can expect the following links on the DML side :

  • Links from SQL Script to Table provided as dependencies
  • Links from client code to Table provided as dependencies

Quality Rules

You can find a full list of rules for this extension, here:

https://technologies.castsoftware.com/?rlH=extensions/com.castsoftware.sqlanalyzer/2.1.0-funcrel.json

Name
Client Side Support
Never use SQL queries with a cartesian product (1101000)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Never use SQL queries with a cartesian product on XXL Tables (1101002)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Avoid non-indexed SQL queries (1101004)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Avoid non-indexed XXL SQL queries (1101006)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Avoid non-SARGable queries (1101008)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Avoid NATURAL JOIN queries (1101010)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Specify column names instead of column numbers in ORDER BY clauses (1101012)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Avoid queries using old style join convention instead of ANSI-Standard joins (1101014)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Always define column names when inserting values (1101026)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Use MINUS or EXCEPT operator instead of NOT EXISTS and NOT IN subqueries (1101028)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Avoid exists and not exists independent clauses (1101032)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

DISTINCT should not be used in SQL SELECT statements (1101034)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Use ANSI standard operators in SQL WHERE clauses (EMBEDDED SQL) (1101036)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Replace OR conditions testing equality on the same identifier in SQL WHERE clauses by an IN test condition (1101038)

COBOL PB VB .NET JAVAC/C++/OBJC IOS PYTHON

Special note about XXL/XXS support

See SQL Analyzer - working with XXL or XXS tables for a DB2 database for more information.

Special notes about Quality Rules on client side

Some Quality Rules are calculated on SQL queries on client side with some limitations:

  • Only Java queries found by inference engine are analysed, for example:
    • Queries that generate dynamic links (eligible to DLM) are not analysed
    • Queries to Hibernate or JPA objects or any other ORM are not analysed
  • COBOL EXEC SQL queries are analysed
  • SQL queries founded in python code

Errors and warning

See here the full list of errors and warnings: SQL Analyzer - errors and warnings.

Known Limitations and Issues

Installation

If you encounter the following error in CAST Server Manager while installing the SQL Analyzer extension, please perform the workaround described here and then attempt the installation again. This error may occur if you have installed a very old and unsupported custom Universal Analyzer language pack that used the same metamodel type names as used in the official SQL Analyzer extension.

SQL Analyzer is incompatible with the schema metamodel. It is generally due to an extension that has changed it's ids

Analysis

  • All name resolving is considered as case insensitive :  may produce wrong links on case insensitive platform 'playing with case' :
    • 2 different tables with the same case insensitive name will be both called
  • Procedure resolution does not handle overriding :
  • when calling an overridden procedure, all overrides will be called
  • ALTER TABLE ... ADD ... syntax is supported. All other syntaxes, like ALTER TABLE ... DELETE .. or ALTER TABLE ... DROP ... or ALTER TABLE ... MODIFY ... etc. are not supported.

  • Moving a table from one database/scheme to another is not supported through RENAME TABLEschema1.tableName1 TOschema2.tableName2.   
  • Sequences are not taken in account and that is not a limitation but a choice because they have no effect on transactions nor quality rules*
  • Oracle synonyms on packages are not taken in account.
  • For the QR 7156 Avoid Too Many Copy Pasted Artifacts, total values are displayed but no detail values.
  • For the QR 1101012 Specify column names instead of column numbers in ORDER BY clauses, the case when a function that returns a number or a numeric variable is used in order by is not reported to violate the rule.

CAST Health Dashboard (ex. Application Analytics Dashboard)

Starting with release 2.1 of the SQL Analyzer extension, the name used to represent the technology has changed from SQL Analyzer to SQL: if you have already transfered snapshots that contain SQL Analyzer analysis results in to a Measurement Service schema, you'll see SQL Analyzer in the list of technologies instead of SQL.

If you would like to change the technology name for existing snapshots, you can change it using the following SQL query run against the Measurement Service schema:

Change technology name in AAD
update DSS_OBJECT_TYPES
set OBJECT_TYPE_NAME = 'SQL'
where OBJECT_TYPE_ID = 1101000


  • No labels