#64 Created triggers-project

Author: rjrudin

examples/sample-project/build.gradle

@@ -158,39 +158,6 @@ ext {
 }
 
 
-/*
- * As of ML 8.0-3, triggers can not yet be managed via the Management REST API, so we still rely on a custom Gradle task
- * that uses XCC to create the trigger. With 8.0-4, you should not use this approach - triggers can instead be defined under src/main/ml-config/triggers.
- */
-task createSampleTrigger(type: com.marklogic.gradle.task.trigger.CreateTriggersTask) {
-    xccUrl = contentXccUrl
-    triggerName = "sample-project-trigger"
-    description = "This is an example of creating a trigger"
-    dataEventCommit = "post"
-    dataEventScopeArgs = ["some-collection"]
-    dataEventContentArgs = ["create", "modify", "delete"]
-    moduleRoot = "/"
-    modulePath = "/ext/sample-project/trigger/sample-trigger.xqy"
-}
-
-
-/*
- * Example of attaching the creation of our trigger to the end of the mlDeploy process. mlPostDeploy is an empty task
- * that is called by mlDeploy after mlAppDeploy runs; mlPostDeploy thus allows for any additional tasks to be added to
- * the deployment process. 
- */
-mlPostDeploy.dependsOn createSampleTrigger
-
-
-/*
- * Example of including a custom command in the deployment process. The order in which it's invoked is determined by
- * the command's "getExecuteSortOrder" method.
- */
-ext {
-    mlAppDeployer.commands.add(new ClearTriggersDatabaseCommand())
-}
-
-
 /*
  * ml-gradle does not blindly process every file in the ml-config/databases directory. It checks for specific files
  * for a content database, a schemas database, and a triggers database. There are specific commands for each file, and
@@ -214,38 +181,54 @@ ext {
 
 
 /*
- * Below is an example of a custom command, which also fixes a bug in ML that should be fixed in the 8.0-4 release. The 
- * bug is - when a pipeline is updated via the Management REST API,  pipeline states are dropped. To address this, we 
- * insert a command to clear the triggers database before any CPF resources are created, thus forcing a create instead 
- * of an update, thereby bypassing the bug. This example also shows how the ManageClient instance in CommandContext can
- * be used to easily make any call to the Management REST API. Note that this class could also be defined in the Gradle
- * buildSrc directory, which is really a better option for keeping your build.gradle file slim.
+ * Example of a custom command, which in this case performs a merge on a database. The benefit of doing this in a 
+ * command (as opposed to a task) is that a command can be included in the mlDeploy and mlUndeploy tasks by adding it to
+ * the mlAppDeployer object, as shown below.
+ * 
+ * This example also shows how the ManageClient instance in CommandContext can be used to easily make any call to the 
+ * Management REST API. Note that this class could also be defined in the Gradle buildSrc directory, which is really a 
+ * better option for keeping your build.gradle file slim.
  */
 import com.marklogic.appdeployer.command.AbstractCommand;
 import com.marklogic.appdeployer.command.CommandContext;
-import com.marklogic.appdeployer.command.SortOrderConstants;
 
-class ClearTriggersDatabaseCommand extends AbstractCommand {
+class MergeContentDatabaseCommand extends AbstractCommand {
     public Integer getExecuteSortOrder() {
-        return SortOrderConstants.DEPLOY_DEFAULT_PIPELINES - 1;
+        return Integer.MAX_VALUE;
     }
     public void execute(CommandContext context) {
-        String dbName = context.getAppConfig().getTriggersDatabaseName();
-        logger.info("Clearing database: " + dbName);
-        context.getManageClient().postJson("/manage/v2/databases/" + dbName, '{"operation":"clear-database"}');
-        logger.info("Cleared database: " + dbName)
+        String dbName = context.getAppConfig().getContentDatabaseName();
+        logger.info("Merging database: " + dbName);
+        context.getManageClient().postJson("/manage/v2/databases/" + dbName, '{"operation":"merge-database"}');
+        logger.info("Merged database: " + dbName)
     }
 }
 
 
 /*
- * Sometimes, you need a custom step, but you want it to be a separate task - not a command that's included when 
- * mlDeploy is invoked. Below is a task that extends MarkLogicTask, which provides access to a number of helpful 
- * objects for implementing custom functionality.
+ * Example of including our custom command in the deployment process. The order in which it's invoked is determined by
+ * the command's "getExecuteSortOrder" method.
+ */
+ext {
+    //mlAppDeployer.commands.add(new MergeContentDatabaseCommand())
+}
+
+
+/*
+ * Below is an example of a custom task that merges a database - just like the command above. The benefit of creating a
+ * task versus a command is that we can invoke this without running a full mlDeploy. The MarkLogicTask class provides
+ * access to a number of helpful objects via methods like getAppConfig() and getManageClient().
  */
 task mergeContentDatabase(type: com.marklogic.gradle.task.MarkLogicTask) {
     description = "Call this task to initiate a merge on the content database"
     doLast {
         getManageClient().postJson("/manage/v2/databases/" + getAppConfig().getContentDatabaseName(), '{"operation":"merge-database"}')
     }
 }
+
+/*
+ * Example of attaching our custom task to the end of the mlDeploy process. mlPostDeploy is an empty task
+ * that is called by mlDeploy after mlAppDeploy runs; mlPostDeploy thus allows for any additional tasks to be added to
+ * the deployment process. 
+ */
+//mlPostDeploy.dependsOn mergeContentDatabase

examples/triggers-project/.gitignore

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

examples/triggers-project/build.gradle

@@ -0,0 +1,19 @@
+plugins {
+  id "com.marklogic.ml-gradle" version "2.0rc3"  
+}
+
+/**
+ * Starting with MarkLogic 8.0-4, triggers can be added via configuration files in the src/main/ml-config/triggers
+ * directory. Prior to that, you'll need to use a task like the one below, as previous version of MarkLogic don't
+ * support creating triggers via the Management REST API.
+ */
+task createSampleTrigger(type: com.marklogic.gradle.task.trigger.CreateTriggersTask) {
+    description = "This is an example of creating a trigger via XCC as opposed to the Management REST API"
+    xccUrl = "xcc://${mlUsername}:${mlPassword}@${mlHost}:${mlRestPort}"
+    triggerName = "sample-trigger"
+    dataEventCommit = "post"
+    dataEventScopeArgs = ["sample"]
+    dataEventContentArgs = ["create", "modify", "delete"]
+    moduleRoot = "/"
+    modulePath = "/ext/sample-trigger.xqy"
+}

examples/triggers-project/gradle.properties

@@ -0,0 +1,7 @@
+mlGradleDependency=com.marklogic:ml-gradle:2.0rc+
+
+mlHost=localhost
+mlAppName=triggers-project
+mlRestPort=8135
+mlUsername=admin
+mlPassword=admin

examples/triggers-project/src/main/ml-config/databases/README.md

@@ -0,0 +1,2 @@
+While ml-gradle will create a triggers database by default, the content-database.json file still needs to exist to associate
+the content database with the triggers database. 

examples/triggers-project/src/main/ml-config/databases/content-database.json

@@ -0,0 +1,4 @@
+{
+  "database-name": "%%DATABASE%%",
+  "triggers-database": "%%TRIGGERS_DATABASE%%"
+}

examples/triggers-project/src/main/ml-config/triggers/my-trigger.json

@@ -0,0 +1,21 @@
+{
+  "name": "my-trigger",
+  "description": "my trigger",
+  "event": {
+    "data-event": {
+      "collection-scope": {
+        "uri": "sample"
+      },
+      "document-content": {
+        "update-kind": "create"
+      },
+      "when": "post-commit"
+    }
+  },
+  "module": "ext/sample-trigger.xqy",
+  "module-db": "%%MODULES_DATABASE%%",
+  "module-root": "/",
+  "enabled": true,
+  "recursive": true,
+  "task-priority": "normal"
+}