Merge pull request #670 from BillFarber/task/createQbvExample

DEVEXP-576: Deploy QBV example project

Author: rjrudin

examples/qbv-example/.gitignore

@@ -0,0 +1,6 @@
+/bin
+.classpath
+.project
+/build
+.gradle
+.settings

examples/qbv-example/README.md

@@ -0,0 +1,5 @@
+This project shows an example of how MarkLogic 11 QBVs can be generated from an Optic
+query and loaded into a schemas database from src/main/ml-schemas/qbv. 
+
+Note that in order for this to work, a schemas database must be created and the content-database.json file must specify
+that schema database. This example is already setup to meet those requirements with a schemas-database.json file.

examples/qbv-example/build.gradle

@@ -0,0 +1,42 @@
+plugins {
+	id "com.marklogic.ml-gradle" version "4.6.0"
+}
+
+repositories {
+	mavenCentral()
+}
+
+configurations {
+	mlcp
+}
+
+dependencies {
+	mlcp 'com.marklogic:mlcp:11.0.3'
+	mlcp files("lib")
+}
+
+/**
+ * Using an MlcpTask to load the data into the content database.
+ * See the mlcp example project (examples/mlcp-project) for more information on this technique.
+ */
+task importEmployeeData(type: com.marklogic.gradle.task.MlcpTask) {
+	classpath = configurations.mlcp
+	command = "IMPORT"
+	database = mlAppConfig.contentDatabaseName
+	output_collections = "sample-import"
+	output_permissions = "rest-reader,read,rest-writer,update"
+	output_uri_replace = ".*import,'/import'"
+	input_file_path = "data"
+	input_file_type = "delimited_text"
+	delimited_root_name = "Employee"
+}
+
+task getEngineeringEmployees(type: com.marklogic.gradle.task.ServerEvalTask) {
+	description = "Using a ServerEvalTask to evaluate a JS script on the server in order to test the Engineering QBV."
+	javascript = "const op = require('/MarkLogic/optic'); op.fromView('HR', 'Engineering').result();"
+}
+
+task getSalesEmployees(type: com.marklogic.gradle.task.ServerEvalTask) {
+	description = "Using a ServerEvalTask to evaluate an XQuery script on the server in order to test the Sales QBV."
+	xquery = 'xquery version "1.0-ml"; import module namespace op="http://marklogic.com/optic" at "/MarkLogic/optic.xqy"; op:from-view("HR", "Sales") => op:result()'
+}

examples/qbv-example/data/employees.csv

@@ -0,0 +1,3 @@
+ID,FirstName,LastName,Department
+1,John,Doe,Sales
+2,Sally,Smith,Engineering

examples/qbv-example/gradle.properties

@@ -0,0 +1,5 @@
+mlHost=localhost
+mlAppName=qbv-project
+mlRestPort=8150
+mlUsername=admin
+mlPassword=admin

examples/qbv-example/lib/logback.xml

@@ -0,0 +1,21 @@
+<configuration>
+
+    <statusListener class="ch.qos.logback.core.status.NopStatusListener" />
+
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="STDOUT" />
+    </root>
+
+    <logger name="com.marklogic" level="INFO" additivity="false">
+        <appender-ref ref="STDOUT" />
+    </logger>
+
+</configuration>
+
+  

examples/qbv-example/src/main/ml-config/databases/content-database.json

@@ -0,0 +1,4 @@
+{
+  "database-name": "%%DATABASE%%",
+  "schema-database": "%%SCHEMAS_DATABASE%%"
+}

examples/qbv-example/src/main/ml-config/databases/schemas-database.json

@@ -0,0 +1,3 @@
+{
+  "database-name": "%%SCHEMAS_DATABASE%%"
+}

examples/qbv-example/src/main/ml-schemas/qbv/engineeringView.sjs

@@ -0,0 +1,5 @@
+'use strict';
+const op = require('/MarkLogic/optic');
+op.fromView('HR', 'employees')
+	.where(op.eq(op.col('Department'), "Engineering"))
+	.generateView('HR', 'Engineering');

examples/qbv-example/src/main/ml-schemas/qbv/salesView.xqy

@@ -0,0 +1,7 @@
+xquery version "1.0-ml";
+
+import module namespace op="http://marklogic.com/optic" at "/MarkLogic/optic.xqy";
+
+op:from-view("HR", "employees")
+   => op:where(op:eq(op:col('Department'), "Sales"))
+   => op:generate-view("HR", "Sales")