Merge pull request #154 from sentrysoftware/feature/issue-129-replace…

…-all-references-to-sql-with-internaldbquery-in-the-documentation

Issue #129: Rename sql type to internalDbQuery

pom.xml

@@ -162,7 +162,7 @@
 			<plugin>
 				<groupId>org.sentrysoftware.maven</groupId>
 				<artifactId>metricshub-connector-maven-plugin</artifactId>
-				<version>1.0.06</version>
+				<version>1.0.07</version>
 			</plugin>
 
 		</plugins>

src/site/markdown/develop/computes/add.md

@@ -9,7 +9,7 @@ The `value` can be a number, or a reference to another column of the same table,
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/and.md

@@ -10,7 +10,7 @@ The `value` can be a number, or a reference to another column of the same table,
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/append.md

@@ -1,7 +1,7 @@
 keywords: append, string, concat, right
 description: Use the "append" compute operation to append a specified string to a source.
 
-# `append` (Append)
+# `append`
 
 The `Append` compute allow to concatenate a value at the end of all the lines in a selected column.
 The `value` can be a number, or a reference to another column of the same table, using the '$' character followed by the column number.
@@ -10,7 +10,7 @@ Since the data is converted from a CSV to a Table, you can add columns by adding
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/array-translate.md

@@ -12,7 +12,7 @@ The `resultSeparator` value can be used to define how to separate the values aft
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/awk.md

@@ -15,7 +15,7 @@ Eg: ```yaml script: ${esc.d}{file::my-script.awk}``` for a script named `my-scri
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/convert.md

@@ -8,7 +8,7 @@ The `convert` compute allows make to convert a column from a hexadecimal value t
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/divide.md

@@ -9,7 +9,7 @@ The `value` can be a number other than '0', or a reference to another column of
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/duplicate-column.md

@@ -8,7 +8,7 @@ The `duplicateColumn` compute allows to duplicate a column. The added column wil
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/exclude-matching-lines.md

@@ -8,7 +8,7 @@ The `excludeMatchingLines` compute allows to remove the lines of your table wher
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/extract-wbem-property.md

@@ -8,7 +8,7 @@ The `ExtractPropertyFromWbemPath` compute allows to extract the specified proper
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/extract.md

@@ -9,7 +9,7 @@ The `subSeparators` value is used to split the original column into an array and
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/index.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, compute
+keywords: develop, compute
 description: This page describes all the compute formats support by the connector
 
 # Computes
@@ -12,7 +12,7 @@ This page describes all the compute formats support by the connector.
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/json2csv.md

@@ -10,7 +10,7 @@ The `properties` value is the list of strings specifying the properties of the e
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/keep-columns.md

@@ -8,7 +8,7 @@ The `keepColumns` compute allows to keep only the selected columns from a table.
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/keep-only-matching-lines.md

@@ -8,7 +8,7 @@ The `KeepOnlyMatchingLines` compute allows to keep only the lines of your table
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/multiply.md

@@ -9,7 +9,7 @@ The `value` can be a number, or a reference to another column of the same table,
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/prepend.md

@@ -10,7 +10,7 @@ Since the data is converted from a CSV to a Table, you can add columns by adding
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/replace.md

@@ -8,7 +8,7 @@ The `Replace` compute allows to replace a specific value in a column by another
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/substring.md

@@ -8,7 +8,7 @@ The `Substring` compute allows to extract a String from a column.
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/subtract.md

@@ -9,7 +9,7 @@ The `value` can be a number, or a reference to another column of the same table,
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/translate-per-bit.md

@@ -9,7 +9,7 @@ The `BitList` is the list of bits to be taken into account.
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/translate.md

@@ -8,7 +8,7 @@ The `Translate` compute allows to translate values from specified column followi
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/computes/xml2csv.md

@@ -8,7 +8,7 @@ The `xml2Csv` compute allows to convert a XML source to a character-separated ta
 ```yaml
 connector:
   # ...
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:

src/site/markdown/develop/connector.md

@@ -1,4 +1,4 @@
-keywords: develop, connector
+keywords: develop
 description: The intended audience of this guide is the advanced user of MetricsHub, who feels confident enough to dig into the depth of connector development.
 
 # Connector
@@ -132,8 +132,8 @@ connector:
     - type: deviceType
       keep: # <enum-array> | possible values: [ vms, osf1, hp, rs6000, linux, oob, nt, network, storage, solaris, sunos ]
       exclude: # <enum-array> | possible values: [ vms, osf1, hp, rs6000, linux, oob, nt, network, storage, solaris, sunos ]
-    # OsCommand criterion
-    - type: osCommand
+    # CommandLine criterion
+    - type: commandLine
       commandLine: # <string>
       errorMessage: # <string>
       expectedResult: # <string>
@@ -199,7 +199,7 @@ metrics:
 constants: # <object>
   <constantName>: # <string>
 
-pre: # <object>
+beforeAll: # <object>
   <sourceKey>: # <source-object>
 
 monitors:
@@ -230,9 +230,9 @@ monitors:
           type: ipmi
           forceSerialization: <boolean>
           computes: # <compute-object-array>
-        # OsCommand Source
-        <osCommand-sourceKey>: # <source-object>
-          type: osCommand
+        # CommandLine Source
+        <commandLine-sourceKey>: # <source-object>
+          type: commandLine
           commandLine: # <string>
           timeout: # <number>
           executeLocally: # <boolean>

src/site/markdown/develop/detection/command-line.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 ## Command Line (Detection)
@@ -11,7 +11,7 @@ connector:
   detection: # <object>
     # ...
     criteria: # <object-array>
-    - type: osCommand
+    - type: commandLine
       commandLine: # <string>
       errorMessage: # <string>
       expectedResult: # <string>
@@ -35,7 +35,7 @@ connector:
 connector:
   detection:
     criteria:
-    - type: osCommand
+    - type: commandLine
       commandLine: naviseccli -help
       expectedResult: Navisphere
       executeLocally: true

src/site/markdown/develop/detection/engine-requirements.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 # Product Requirements (Detection)

src/site/markdown/develop/detection/http.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 # HTTP (Detection)

src/site/markdown/develop/detection/index.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, detection
+keywords: develop, detection
 description: This page defines the connector’s detection section.
 
 # Detection

src/site/markdown/develop/detection/ipmi.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 ## IPMI (Detection)

src/site/markdown/develop/detection/process.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 ## Process (Detection)

src/site/markdown/develop/detection/resource-type.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 # Device Type (Detection)

src/site/markdown/develop/detection/service.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 # Service (Detection)

src/site/markdown/develop/detection/snmp-get.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 # SNMP Get (Detection)

src/site/markdown/develop/detection/snmp-getnext.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 # SNMP GetNext (Detection)

src/site/markdown/develop/detection/sql.md

@@ -0,0 +1,38 @@
+keywords: develop, sql, criteria
+description: This page defines the detection’s criteria that are defined in a connector.
+
+# SQL (Detection)
+
+The goal of this part is to see how to define SQL criteria.
+
+```yaml
+connector:
+  # ...
+  detection: # <object>
+    # ...
+    criteria: # <object-array>
+      - type: sql
+        query: # <string>
+        expectedResult: # <string>
+        errorMessage: # <string>
+```
+
+## Input Properties
+
+| Input Property   | Description                                                              |
+| ---------------- | ------------------------------------------------------------------------ |
+| `query`          | SQL query to be executed                                                 |
+| `expectedResult` | Regular expression that is expected to match the result of the SQL query |
+| `errorMessage`   | The message to display if the detection criterion fails                  |
+
+### Example
+
+```yaml
+connector:
+  detection:
+    criteria:
+      - type: sql
+        query: SELECT @@version_comment REGEXP 'mysql' AS is_mysql;
+        expectedResult: 1
+        errorMessage: Not a MySQL Server
+```

src/site/markdown/develop/detection/wbem.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 # WBEM (Detection)

src/site/markdown/develop/detection/wmi.md

@@ -1,4 +1,4 @@
-keywords: develop, connector, criteria
+keywords: develop, criteria
 description: This page defines the detection’s criteria that are defined in a connector.
 
 # WMI (Detection)