Changeset 1045 for MDRepository/trunk/xquery/README

Timestamp:

01/09/11 20:28:15 (13 years ago)

Author:

vronk

Message:

mainly added new API-function: scanIndex
(group.xsl used for aggregating)

File:

• MDRepository/trunk/xquery/README (modified) (5 diffs)

MDRepository/trunk/xquery/README

@@ -12 +12 @@
         c) set admin pwd 
         
-        ...?
+        d) you may want to add memory to the JVM
+           under bin/functions.d/eXist-settings.sh#set_java_options()
+        
+        e) you may also want to grow the cache in conf.xml
+                 <db-connection cacheSize="48M" collectionCache="24M" database="native"        
+                  where @cacheSize could be around 512M 
+      and @collectionCache should be around one third of the @cacheSize
+
 
 1. add scripts to: /db/clarin
@@ -18 +25 @@
                 + cmd-model.xqm has all the logic
                 + cmd-model.xql is the script being called as the interface
-                + cmd-stats.xql is meant for testing purposes, but not integrated yet
-                + init-cache.xql is meant for refreshing the cache with some long-running (resource-intensive) queries, meant to run once upon dataset change
+         (+) cmd-stats.xql is meant for testing purposes, but not integrated yet
+         (+) init-cache.xql is meant for refreshing the cache with some long-running (resource-intensive) queries, meant to run once upon dataset change
 
-2. add data to  /db/cmdi-mirror
-         (the file-system structure will be reflected in the "collection"-structure within exist,
-         however this is irrelevant for the MDRepository methods.
-         Those rely on the linking via handles in MdSelfLink/ResourceRef and IsPartOf elements of the MDRecords.
-         The handles in IsPartOf are redundant (necessary for faster collection-constraint search) 
-         and can be derived from the ResourceRef/MdSelfLink link.
-         This can be done before storing the data in the repository,
-         or after the import directly in the repository (scripts for this will be available soon)
 
-3. add a clarin-user in /db/system/users.xml
+2. add a clarin-user in /db/system/users.xml
    (needed for writing into the cache)
    + /db/clarin/writer.xml with given user, like this:
@@ -39 +38 @@
 
 
-4. create a collection for caching, 
-        eg: /db/common/clarin/freqs
+3. create a collection for caching, 
+        eg: /db/cache
         this has to correspond to the entry in cmd-model.xqm:
-        declare variable $cmd-model:commonFreqsPath as xs:string := "/db/common/clarin/freqs";
+        declare variable $cmd-model:commonFreqsPath as xs:string := "/db/cache";
         
         If you change something, you have to manually clear the cache-collection.
@@ -50 +49 @@
           for getCollections: collection{maxdepth}-{hash({collection-handle})}
           for queryModel:   values{maxdepth}-{hash({simple xpath from q-param})}
+
         
-5. depending on your server-setup you should be able to get your first query under somewhere like:              
+4. define indices 
+         copy cmdi-mirror.xconf into /db/system/config/db/cmdi-mirror
+          
+          
+5. add data to  /db/cmdi-mirror
+         (the file-system structure will be reflected in the "collection"-structure within exist,
+         however this is irrelevant for the MDRepository methods.
+         Those rely on the linking via handles in MdSelfLink/ResourceRef and <IsPartOf> elements of the MDRecords.
+         The handles in <IsPartOf> are redundant (necessary for faster collection-constraint search) 
+         and can be derived from the ResourceRef/MdSelfLink link.
+         This can be done before storing the data in the repository,
+         or after the import directly in the repository (XUpdate-scripts for this will be available soon)
+
+         The top level collection record is by convention called colleciton_root.cmdi
+         and is marked with: <IsPartOf>root</IsPartOf>
+         (So every dataset (olac, lrt, imdi) has one such MDRecord.)
+
+6. depending on your server-setup (port) you should be able to get your first query under somewhere like:               
                 
         http://localhost:8680/exist/rest/db/clarin/cmd-model.xql?q=Components
@@ -61 +78 @@
         Avoid starting multiple times.
         You can see in the cache-collection, if the results are ready.
-        
+
+
         
 == test suite ==