File Search Language

• File-Specific Grammar
• Examples
• SQL Terms

File-Specific Grammar

The file 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 three new forms: metric-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)
  This behaviour also applies to plain text search, but does not have a noticeable effect there: plain text search in the file search language only covers the file field, which will never contain the empty string or be empty.

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

string-field : any field-name whose condition type is "word | quoted string" 

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

ext-operator : <
             | <=
             | >=
             | >
                         
field-name : adesc 
           | aid
           | analysis          
           | directory
           | file
           | language
           | path
           | pdesc
           | pid
           | project
           | ptree_path 
           | sfhash
           | sql

field-condition terms

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

directory, file, and path searches

If field-name is directory, file, or path, comparison:

• is case-insensitive, and
• does not distinguish between forward slashes and backslashes.

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

Plain text search terms—word, quoted-string, and none—are compared against File, with substring search (and see note above):

• str is equivalent to file:str

Examples

The following table shows simple example queries using field-names and metric-conditions from the file search language

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 insert cond as a term in the WHERE clause used to implement the search. Only results satisfying this term will be returned.

• 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 file 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.