Administrator’s Guide - MarkLogic
Administrating MarkLogic Server
MarkLogic 11
Publication date 2024-06-05
Copyright ? 2024 Progress Software Corporation
All Rights Reserved
MarkLogic 11
Table of Contents
1. Introduction .....................................................................................................................
1.1. Objectives .............................................................................................................
1.2. Audience ..............................................................................................................
1.3. Scope and Requirements ......................................................................................
1.4. Architecture Overview ...........................................................................................
2. Administrative (Admin) Interface .......................................................................................
2.1. Overview of the Admin Interface .............................................................................
2.2. Accessing the Admin Interface ...............................................................................
2.3. Logging Off the Admin Interface .............................................................................
2.4. Creating and Managing Administrators ...................................................................
2.5. The admin-ui-user Role .........................................................................................
3. Common Administrative Procedures ..................................................................................
3.1. Installing and Upgrading MarkLogic Server .............................................................
3.2. Starting MarkLogic Server ......................................................................................
3.3. Stopping MarkLogic Server ....................................................................................
3.3.1. From the Admin Interface ............................................................................
3.3.2. With a System Command ............................................................................
3.3.3. With a Server-Side JavaScript .....................................................................
3.3.4. With an XQuery Script ................................................................................
3.4. Restarting MarkLogic Server ..................................................................................
3.4.1. From the Admin Interface ............................................................................
3.4.2. With a Server-Side JavaScript .....................................................................
3.4.3. With an XQuery Script ................................................................................
3.5. Creating and Configuring Forests and Databases ....................................................
3.6. Creating and Configuring App Servers ....................................................................
3.7. Setting Up Users, Roles, Privileges, and Permissions ..............................................
3.8. Loading Content into a Database ...........................................................................
3.9. Running the XQuery Use Cases and Building Simple Applications ...........................
3.10. Backing Up and Restoring Data ............................................................................
3.11. Monitoring and Tuning Performance .....................................................................
3.12. Scripting and Scheduling Administrative Tasks ......................................................
3.13. Configuring Clusters, Groups, and Failover ...........................................................
4. Clusters ...........................................................................................................................
4.1. Overview of Cluster Configuration ..........................................................................
4.2. OpenSSL FIPS 140-2 Mode ...................................................................................
4.3. Procedures for Configuring Clusters .......................................................................
4.3.1. Configuring OpenSSL FIPS 140-2 Mode ......................................................
4.3.2. Configuring Simple Cluster Encryption .........................................................
4.3.3. Coupling Clusters .......................................................................................
4.4. Running Behind a Load Balancer or Reverse Proxy ................................................
4.5. Configuring a MarkLogic Application Message and Banner ......................................
4.5.1. Example Configuration ................................................................................
4.5.2. Configuration Reference .............................................................................
4.5.3. Example: Creating a New Configuration Document .......................................
4.5.4. Example: Activating/Deactivating a Configuration .........................................
4.5.5. Example: Modifying the Notification Dialog Text ............................................
4.5.6. Example: Modifying the Banner Text ............................................................
5. Groups ............................................................................................................................
5.1. Overview of Groups ...............................................................................................
5.2. Example ...............................................................................................................
5.3. Procedures for Configuring and Managing Groups ..................................................
5.3.1. Creating a New Group ................................................................................
5.3.2. Group Settings ...........................................................................................
2024-06-05 15:20
Administrating MarkLogic Server
13
13
13
13
14
16
16
16
17
17
17
18
18
18
18
18
19
19
19
19
19
20
20
20
20
21
21
21
21
22
22
22
24
24
24
24
24
24
27
29
30
31
31
32
32
32
33
34
34
34
35
35
36
Page 2
MarkLogic 11
5.3.3. Enabling SSL Communication over XDQP ...................................................
5.3.4. Configuring an SMTP Server .......................................................................
5.3.5. Restarting All Hosts in a Group ....................................................................
5.3.6. Deleting a Group ........................................................................................
5.4. App Server Status Page ........................................................................................
5.5. Access the App Server Status Page .......................................................................
6. HTTP Servers ..................................................................................................................
6.1. Creating a New HTTP Server .................................................................................
6.2. Setting Output Options for an HTTP Server .............................................................
6.3. Viewing HTTP Server Settings ...............................................................................
6.4. Deleting an HTTP Server .......................................................................................
6.5. Canceling a Request .............................................................................................
7. XDBC Servers .................................................................................................................
7.1. Creating a New XDBC Server ................................................................................
7.2. Setting Output Options for an XDBC Server ............................................................
7.3. Viewing XDBC Server Settings ...............................................................................
7.4. Deleting an XDBC Server ......................................................................................
7.5. Canceling a Request .............................................................................................
8. WebDAV Servers .............................................................................................................
8.1. Accesses a Database for Read and Write, Not XQuery Execution ............................
8.2. WebDAV Server Security .......................................................................................
8.3. Directories ............................................................................................................
8.3.1. Automatic Directory Creation in a Database Settings ....................................
8.3.2. Properties and URIs of Directories ...............................................................
8.4. Server Root Directory ............................................................................................
8.5. Documents in a WebDAV Server ............................................................................
8.6. Procedures for Creating and Managing WebDAV Servers ........................................
8.6.1. Creating a New WebDAV Server .................................................................
8.6.2. Setting Output Options for a WebDAV Server ...............................................
8.6.3. Viewing WebDAV Server Settings ................................................................
8.6.4. Deleting a WebDAV Server .........................................................................
8.6.5. Canceling a Request ..................................................................................
8.7. WebDAV Clients ....................................................................................................
8.7.1. Tested WebDAV Clients ..............................................................................
8.7.2. General Steps to Connect to a Server ..........................................................
8.7.3. Connecting to a Web Folder Using Windows 10 File Explorer ........................
8.7.4. Connecting to a Web Folder Using Windows 9 or Earlier File Explorer ...........
8.8. Example: Setting Up a WebDAV Server to Add or Modify Documents Used by
Another Server ............................................................................................................
9. ODBC Servers .................................................................................................................
9.1. Creating a New ODBC Server ................................................................................
9.2. Setting Output Options for an ODBC Server ............................................................
9.3. Viewing ODBC Server Settings ..............................................................................
9.4. Deleting an ODBC Server ......................................................................................
9.5. Canceling a Request .............................................................................................
9.6. ODBC Request Monitoring and Cancellation ...........................................................
10. Auditing Events ..............................................................................................................
10.1. Overview of Auditing ............................................................................................
10.1.1. Audit Log Files .........................................................................................
10.1.2. Restricting Audit Events ............................................................................
10.1.3. Audit Successful, Unsuccessful, or Both Types of Events ............................
10.1.4. Enabled at the Group Level .......................................................................
10.2. Auditable Events .................................................................................................
10.2.1. Audit Log Content .....................................................................................
10.2.2. Sample Audit Logs ...................................................................................
2024-06-05 15:20
Administrating MarkLogic Server
40
43
43
43
44
44
45
45
47
48
48
49
50
50
52
53
53
53
54
54
54
55
55
56
56
57
57
57
59
59
60
60
60
60
61
62
62
63
65
66
69
69
69
69
70
71
71
71
71
72
72
72
75
76
Page 3
MarkLogic 11
10.3. Configuring Auditing for a Group .......................................................................... 76
10.3.1. Enabling Auditing for a Group .................................................................... 76
10.3.2. Disabling Auditing for a Group ................................................................... 76
10.3.3. Configuring Auditing to Audit Certain Events and Set Up Certain
Restrictions ......................................................................................................... 77
11. Managing User Requests and Monitoring Login Attempts .................................................. 78
11.1. Managing Concurrent User Requests ................................................................... 78
11.1.1. Limiting Concurrent Requests with User Request Limits .............................. 78
11.1.2. Configuring User Concurrent Request Controls ........................................... 78
11.2. Setting Request Blackouts on an App Server ......................................................... 78
11.2.1. Configuring Request Blackouts .................................................................. 78
11.2.2. Deleting Request Blackouts ....................................................................... 79
11.3. Storing and Monitoring the Last User Login Attempt ............................................... 79
11.3.1. Storing Last User Login Information in a Last-Login Database ..................... 79
11.3.2. Configuring User Login Monitoring ............................................................. 79
11.3.3. Displaying the Last Login Information ......................................................... 80
12. Databases ..................................................................................................................... 81
12.1. Understanding Databases .................................................................................... 81
12.1.1. Schemas and Security Databases ............................................................. 81
12.1.2. Modules Database .................................................................................... 81
12.1.3. Triggers Database .................................................................................... 82
12.1.4. Database Settings .................................................................................... 82
12.1.5. Example of Databases in MarkLogic Server ............................................... 87
12.2. Creating a New Database .................................................................................... 88
12.3. Attaching and/or Detaching Forests to/from a Database ......................................... 89
12.4. Viewing Database Settings .................................................................................. 89
12.5. Loading Documents into a Database .................................................................... 89
12.6. Merging a Database ............................................................................................ 90
12.7. Reindexing a Database ........................................................................................ 90
12.8. Clearing a Database ............................................................................................ 90
12.9. Disabling a Database ........................................................................................... 91
12.10. Deleting a Database .......................................................................................... 91
12.11. Checking and Setting Permissions for a Document in a Database ......................... 92
13. Word Query Database Settings ....................................................................................... 93
13.1. Understanding the Word Query Configuration ....................................................... 93
13.1.1. Overview of Configuration Options ............................................................. 93
13.1.2. Understanding Which Elements are Included and Excluded ........................ 93
13.1.3. Adding a Weight to Boost or Lower the Relevance of an Included Element ... 95
13.1.4. Specifying an Attribute Value for an Included Element ................................. 96
13.1.5. Understanding the Index Option Configuration ............................................ 96
13.2. Configuring Customized Word Query Settings ....................................................... 96
14. Fields Database Settings ................................................................................................ 98
14.1. Overview of Fields ............................................................................................... 98
14.2. Understanding Field Configurations ...................................................................... 98
14.2.1. Overview of Field Configuration Options ..................................................... 98
14.2.2. Root and Path Fields ................................................................................ 99
14.2.3. Metadata Fields ...................................................................................... 104
14.2.4. Understanding the Index Option Configuration .......................................... 104
14.3. Field Word Lexicons and Field Value Lexicons .................................................... 105
14.4. Configuring Fields ............................................................................................. 105
14.4.1. Configuring a New Path or Root Field ...................................................... 105
14.4.2. Configuring a New Metadata Field ........................................................... 106
14.4.3. Modifying an Existing Field ...................................................................... 107
14.4.4. Creating a Range Index on a Field ........................................................... 107
15. Understanding and Controlling Database Merges ........................................................... 108
2024-06-05 15:20
Administrating MarkLogic Server
Page 4
MarkLogic 11
15.1. Overview of Merges: Merges are Good ............................................................... 108
15.1.1. Dynamic and Self-Tuning ........................................................................ 108
15.1.2. What Happens During a Merge ................................................................ 108
15.1.3. Dangers of Disabling Merges .................................................................. 108
15.1.4. Merges Will Change Scores .................................................................... 109
15.2. Setting Merge Policy .......................................................................................... 109
15.2.1. Overview of the Merge Policy Controls ..................................................... 109
15.2.2. Configuring the Merge Policy ................................................................... 110
15.3. Blackout Periods for Merges ............................................................................... 111
15.3.1. Understanding Merge Blackouts ............................................................... 111
15.3.2. Configuring Merge Blackout Periods ......................................................... 111
15.3.3. Deleting Merge Blackout Periods .............................................................. 111
15.4. Merges and Point-in-Time Queries ..................................................................... 112
15.5. Setting a Negative Merge Timestamp to Preserve Fragments for a Rolling
Window of Time ......................................................................................................... 112
15.6. Monitoring a Merge ............................................................................................ 112
15.6.1. Messages in the ErrorLog.txt File ............................................................. 112
15.6.2. Database Status Page ............................................................................ 113
15.7. Explicit Merge Commands ................................................................................. 113
15.7.1. Manually Initiating a Merge ...................................................................... 113
15.7.2. Canceling a Merge ................................................................................. 114
15.8. Configuring Merge Policy Rules .......................................................................... 114
15.8.1. Determining the Baseline for Your Merges ................................................ 114
15.8.2. If You Want to Reduce the Number of "Large" Merges .............................. 115
15.8.3. Other Solutions ...................................................................................... 117
16. Database Rebalancing ................................................................................................. 118
16.1. Overview of the Database Rebalancer ................................................................ 118
16.2. Rebalancer Trigger Events ................................................................................. 119
16.3. Rebalancer Document Assignment Policies ........................................................ 119
16.3.1. Bucket Assignment Policy ....................................................................... 119
16.3.2. Segment Assignment Policy .................................................................... 121
16.3.3. Statistical Assignment Policy ................................................................... 121
16.3.4. Range Assignment Policy ....................................................................... 122
16.3.5. Query Assignment Policy ........................................................................ 124
16.3.6. Legacy Assignment Policy ....................................................................... 125
16.3.7. Summary of Assignment Policies ............................................................. 126
16.4. How the Rebalancer Moves Documents .............................................................. 126
16.4.1. How Data is Moved When a Forest is Attached to the Database ................ 127
16.4.2. How Data is Moved When a Forest is Retired from the Database .............. 127
16.5. Configuring the Rebalancer on a Database ......................................................... 127
16.6. Configuring the Rebalancer on a Forest .............................................................. 127
16.7. Retiring a Forest from the Database ................................................................... 128
16.8. Checking the Rebalancer Status ........................................................................ 128
16.9. How the Rebalancer Interacts with Other Database and Forest Settings ............... 128
16.9.1. Database Replication .............................................................................. 128
16.9.2. Restoring a Database from a Backup ....................................................... 129
16.9.3. Tiered Storage ........................................................................................ 129
16.9.4. Fast Locking ........................................................................................... 129
16.9.5. Delete-Only and Read-Only Forests ........................................................ 129
16.10. Rebalancer Settings after Upgrading from an Earlier Release ............................. 130
17. Tiered Storage ............................................................................................................. 131
17.1. Terms Used in This Section ................................................................................ 131
17.2. Overview of Tiered Storage ................................................................................ 132
17.3. Range Partitions ................................................................................................ 134
17.4. Query Partitions ................................................................................................ 135
2024-06-05 15:20
Administrating MarkLogic Server
Page 5
................
................
In order to avoid copyright disputes, this page is only a partial summary.
To fulfill the demand for quickly locating and searching documents.
It is intelligent file search solution for home and business.
Related searches
- teacher s guide sri lanka
- chemistry teacher s guide 2019 download
- man s guide to divorce
- a man s guide to women
- java a beginner s guide pdf
- men s guide to understanding women
- college administrator s gp
- teacher s guide first grade wonders
- the teacher s guide wonders 2nd grade
- wonders teacher s guide grade 2
- iphone 11 beginner s guide youtube
- beginner s guide to social media