src/app/assets/configuration/dsl_detailedHelp.json

   1 {
   2   "simple": {
   3     "abstract" : "Easy queries to display a node with properties",
   4     "notation": [
   5       {
   6         "notation": "complex*('key','value')",
   7         "description": "Display Complex with key=value"
   8       },
   9       {
  10         "notation": "complex*('key1','val1')('key2','val2')",
  11         "description": "Display Complex with key1=val1 AND key2=val2"
  12       },
  13       {
  14         "notation": "complex*('key1','val1')!('key2','val2')",
  15         "description": "Negation - Display Complex with key1=val1 AND key2!=val2"
  16       },
  17       {
  18         "notation": "complex*!('key1','val1')!('key2','val2')",
  19         "description": "Negation - Display Complex with key1!=val1 AND key2!=val2"
  20       }
  21     ]
  22   },
  23   "traversal":{
  24     "abstract" : "Build a Query to traverse from one node to the next",
  25     "notation": [
  26       {
  27         "notation": "complex*('country','val') > cloud-region*",
  28         "description": "Traverse from Complex to Cloud-region and Display Complexes and Cloud-Regions"
  29       },
  30       {
  31         "notation": "complex*('country','val') > cloud-region*('key1','val1')('key2''val2')",
  32         "description": "Traverse from Complex to Cloud-region with filters and display Complexes and Cloud-Regions"
  33       },
  34       {
  35         "notation": "generic-vnf*('nf-type','abc') > vserver > tenant > cloud-region*('key','val') ",
  36         "description": "Chain of traversals "
  37       }
  38     ]
  39   },
  40   "union": {
  41     "abstract" : "Build a Query to have a union of nodes",
  42     "notation": [
  43       {
  44         "notation": " complex* (‘key’,’value’) > [cloud-region*, availability-zone*]",
  45         "description": "Display union of nodes"
  46       },
  47       {
  48         "notation": "generic-vnf('key','val')> [pserver*, vserver > pserver*]",
  49         "description": "Traversal within a Union - Display pserver and vserver for a node"
  50       }
  51     ]
  52   },
  53   "limit": {
  54     "abstract": "Build a Query to limit the display of nodes",
  55     "notation": [
  56       {
  57         "notation": " complex*('country','USA') LIMIT 1",
  58         "description": "Display the complex in USA limiting the result to 1 "
  59       },
  60       {
  61         "notation": "generic-vnf('key','val')> [pserver*, vserver > pserver*] LIMIT 5",
  62         "description": "Display the first 5 pservers in a generic-vnf"
  63       }
  64     ]
  65   },
  66   "topology": {
  67     "abstract" : "Commonly used topology Queries",
  68     "notation": [
  69       {
  70         "notation": " generic-vnf('key','val')> [vnfc*, vserver*, pnf*, pserver*, vserver > pserver*]",
  71         "description": "Display the fn-topology "
  72       },
  73       {
  74         "notation": "pnf > [complex* , p-interface* > physical-links* > p-interface >[ pserver* , pnf*]",
  75         "description": "Display the pnf topology"
  76       }
  77     ]
  78   },
  79   "negation": {
  80     "abstract": "Build a NOT Query ",
  81     "notation": [
  82       {
  83         "notation": " complex*!('country','USA') LIMIT 1",
  84         "description": "Display the complex NOT in USA   "
  85       },
  86       {
  87         "notation": "complex > [cloud-region*, availability-zone*!('hypervisor-type','VMWare')]",
  88         "description": "Display availability-zone which does NOT have hypervisor=VMWare"
  89       }
  90     ]
  91   },
  92   "advanced": {
  93     "abstract": "Build an Advanced Query ",
  94     "notation": [
  95       {
  96         "notation": "complex*('key',EQ('value'))",
  97         "description": "EQ = equals"
  98       },
  99       {
 100         "notation": "complex*('key',NEQ('value'))",
 101         "description": "NEQ = not equals"
 102       },
 103       {
 104         "notation": "complex*('key',GT('value'))",
 105         "description": "GT = greater than"
 106       },
 107       {
 108         "notation": "complex*('key',LT('value'))",
 109         "description": "LT = less than"
 110       },
 111       {
 112         "notation": "complex*('key',GTE('value'))",
 113         "description": "GTE = greater than or equal"
 114       },
 115       {
 116         "notation": "complex*('key',LTE('value'))",
 117         "description": "LTE = less than or equal"
 118       },
 119       {
 120         "notation": "complex*('key',REGEX('^.*value'))",
 121         "description": "REGEX = Matching a given POSIX regular expressions pattern"
 122       },
 123       {
 124         "notation": "complex*('key',NOT_REGEX('^.*value'))",
 125         "description": "NOT_REGEX = Not matching a given POSIX regular expression pattern"
 126       },
 127       {
 128         "notation": "complex*('key', CONTAINS('value'))",
 129         "description": "CONTAINS = containing the string"
 130       },
 131       {
 132         "notation": "complex*('key',NOT_CONTAINS('value'))",
 133         "description": "NOT_CONTAINS = not containing the string"
 134       },
 135       {
 136         "notation": "complex*('key',STARTS_WITH('value'))",
 137         "description": "STARTS_WITH = Starting with the string"
 138       },
 139       {
 140         "notation": "complex*('key',NOT_STARTS_WITH('value'))",
 141         "description": "NOT_STARTS_WITH = Not starting with the string"
 142       },
 143       {
 144         "notation": "complex*('key',ENDS_WITH('value'))",
 145         "description": "ENDS_WITH = Ending with the string"
 146       },
 147       {
 148         "notation": "complex*('key',NOT_ENDS_WITH('value'))",
 149         "description": "NOT_ENDS_WITH = Not ending with the string"
 150       }
 151     ]
 152   }
 153 }