Project Search Language

• Grammar
• Examples
• SQL Terms

Grammar

The project search language grammar is based on the standard CodeSonar search grammar, with several extensions:

• In addition to the term (T) forms provided in the standard search grammar, there are four new forms: metric-condition, property-condition, ilike-condition, and imatch-condition.
• There are domain-specific field-name values.
• none (case insensitive) is not treated as an ordinary word. Instead, it matches all of the following.
  • literal string none (case insensitive)
  • fields whose value is the empty string
  • empty fields (that is, fields that don't contain any value at all, not even a default value)
  Plain text search in the project search language covers several fields, including some that many users choose to leave empty, such as Project Description (pdesc). Consequently, performing a plain text search for none (or "none", which CodeSonar will normalize to none) may match projects that do not contain literal string none.To avoid this issue, use one or more field-condition, ilike-condition, or imatch-condition terms to restrict the search to the precise field or fields you are interested in.

Literal strings are displayed in pink text.

T : quoted-string
  | metric-condition
  | ilike-condition
  | imatch-condition
  | field-condition
  | ( T )
  | unary T
  | T binary T
  | T T
  | word
  | none
  
metric-condition : metric-tag ext-operator num
                 | metric-tag operator num-range

metric-tag : the tag of any analysis-granularity metric class (built-in or user-defined) on the hub 

property-condition : property-key operator word
                   | property-key operator quoted-string

property-key : the key of any user-assigned analysis property associated with at least one analysis on the hub 

ext-operator : <
             | <=
             | >=
             | >

field-name : ancestor 
           | autodelete_rules 
           | created 
           | parent 
           | parent_id 
           | pdesc 
           | pid 
           | project 
           | ptree_path 
           | last_address 
           | last_adesc 
           | last_analysis 
           | last_dryrun 
           | last_filecount 
           | last_finished 
           | last_install 
           | last_machine 
           | last_prjfiles 
           | last_protected 
           | last_started 
           | last_user 
           | last_warningcount
           | sql 
   

field-condition terms

The following table shows the relationship between the project-specific field-name values and the properties of a project, along with the expected type of the condition part of a field-condition.

Although metric-tag and property-key are not field-name values, we include them in this table for completeness.

Plain text terms: word, quoted-string, and none

Plain text search terms—word, quoted-string, and none—are compared against a subset of the fields, with substring search:

• str is equivalent to
  last_install:str | project:str | last_user:str | last_adesc:str | last_machine:str | last_prjfiles:str | last_address:str | pdesc:str | last_analysis:str

Examples

SQL Terms

The sql field-name is provided to allow extra search customization, but is not supported. It is only available to users with G_SQL_CONSOLE permission.

For a search that includes a field-condition of the form

CodeSonar will obtain search results by executing an SQL statement of the form

SELECT <your specified columns>
   FROM <CodeSonar-determined relation>
   WHERE <other-terms1 OP1> cond  <OP2 other-terms2>
   ORDER BY <your specified order>
  

where

• In cases where the FROM clause does not include attributes that you want to test in the WHERE clause, you will need to include a suitable EXISTS statement in cond. For example, to find projects with twenty or more analyses on the hub:
  sql:"exists (select cs_analysis.project_id from cs_analysis where cs_project.id = cs_analysis.project_id group by cs_analysis.project_id having count(cs_analysis.id) >= 20)"
• To see samples of CodeSonar's SQL queries in general and WHERE clauses in particular, use your web browser to view the source of any project search results page. The SQL query used to obtain the results shown on the page is included in an HTML comment directly above the result table.
• The hub database schema is available for inspection at $CSONAR/codesonar/py/SCHEMA.
  You can also use the SQL Console to examine the schema programmatically.