III.D Other tasks - kghmanuel/ml-gradle GitHub Wiki

Admin tasks

These tasks are meant for wiring fresh installations of MarkLogic.

Task	Description
mlInit	Perform a one-time initialization of a MarkLogic server; uses the properties 'mlLicenseKey' and 'mlLicensee'
mlInstallAdmin	Perform a one-time installation of an admin user; uses the properties 'mlAdminUsername'/'mlUsername' and 'mlAdminPassword'/'mlPassword'

Cluster tasks

Task	Description
mlAddHost	Add host to the cluster; must define 'host', 'hostGroup' (optional), and 'hostZone' (optional) properties
mlDisableSslFips	Disable SSL FIPS across the cluster
mlEnableSslFips	Enable SSL FIPS across the cluster
mlModifyCluster	Modify the properties of the local cluster based on the ml-config/clusters/local-cluster.json file
mlRemoveHost	Remove a host from the cluster; must define 'host' property
mlRestartCluster	Restart the local cluster

Data Movement tasks

These tasks makes use of DMSDK.

Task	Description
mlAddCollections	Add collections to documents. Run with -PjobProperties (no value needed) for more information.
mlAddPermissions	Add permissions to documents. Run with -PjobProperties (no value needed) for more information.
mlDeleteCollections	Delete collections. Run with -PjobProperties (no value needed) for more information.
mlExportBatchesToDirectory	Export batches of documents to files in a directory. Run with -PjobProperties (no value needed) for more information.
mlExportBatchesToZips	Export batches of documents to zips in a directory. Run with -PjobProperties (no value needed) for more information.
mlExportToFile	Export documents to a single file. Run with -PjobProperties (no value needed) for more information.
mlExportToZip	Export documents to a single zip. Run with -PjobProperties (no value needed) for more information.
mlRemoveCollections	Remove collections from documents. Run with -PjobProperties (no value needed) for more information.
mlRemovePermissions	Remove permissions from documents. Run with -PjobProperties (no value needed) for more information.
mlSetCollections	Set collections on documents. Run with -PjobProperties (no value needed) for more information.
mlSetPermissions	Set permissions on documents. Run with -PjobProperties (no value needed) for more information.

Development tasks

These tasks are meant for stubbing out resources. mlNew[Project] is what we used in Quick Start

Task	Description
mlCreateResource	Create a new resource extension in the modules services directory; use -PresourceName and -PresourceType to set the resource name and type (either xqy or sjs)
mlCreateTransform	Create a new transform in the modules transforms directory; use -PtransformName and -PtransformType to set the transform name and type (xqy, xsl, or sjs)
mlExportResources	Export resources based on a properties file specified via -PpropertiesFile, -Pprefix, or -Pregex; use -PincludeTypes to select resource types to export via a comma-delimited string; use -PexportPath to specify where to export resources to
mlNewProject	Run a wizard for creating a new project, which includes running mlScaffold
mlPrepareRestApiDependencies	Downloads (if necessary) and unzips in the build directory all mlRestApi dependencies
mlPrintTokens	Print the customTokens map on the mlAppConfig object (typically for debugging purposes)
mlScaffold	Generate project scaffold for a new project

Entity Services tasks

Task	Description
mlGenerateModelArtifacts	Generate model artifacts for the Entity Services models in the default directory of ./data/entity-services

Help tasks

Task	Description
buildEnvironment	Displays all buildscript dependencies declared in root project 'ml-gradle-test'.
components	Displays the components produced by root project 'ml-gradle-test'. [incubating]
dependencies	Displays all dependencies declared in root project 'ml-gradle-test'.
dependencyInsight	Displays the insight into a specific dependency in root project 'ml-gradle-test'.
dependentComponents	Displays the dependent components of components in root project 'ml-gradle-test'. [incubating]
help	Displays a help message.
model	Displays the configuration model of root project 'ml-gradle-test'. [incubating]
projects	Displays the sub-projects of root project 'ml-gradle-test'.
properties	Displays the properties of root project 'ml-gradle-test'.
tasks	Displays the tasks runnable from root project 'ml-gradle-test'.

qconsole tasks

Task	Description
mlExportWorkspaces	Export workspaces from qconsole
mlImportWorkspaces	Import workspaces into qconsole

Roxy tasks

These tasks are specially made to assist in migrating users from ml-roxy to ml-gradle. A more in-depth discussion about this transition is available at [TODO: to be made]

Task	Description
mlRoxyMigrateBuildSteps	Migrate build steps from deploy/app_specific.rb into custom Gradle tasks. Use -ProxyProjectPath to define the location of your Roxy project, and -PappSpecificPath to define a path other than deploy/app_specific.rb
mlRoxyMigrateFiles	Migrate Roxy source files into this Gradle project. Use -ProxyProjectPath to define the location of your Roxy project.
mlRoxyMigrateProject	Run all tasks for migrating a Roxy project into this Gradle project. Use -ProxyProjectPath to define the location of your Roxy project.
mlRoxyMigrateProperties	Migrate Roxy properties into the gradle.properties file in this project. Use -ProxyProjectPath to define the location of your Roxy project.

Shell tasks

Task	Description
mlShell	Run groovysh with MarkLogic-specific support built in