Platform Explorer / Nuxeo Platform 11.3

Component org.nuxeo.ecm.core.bulk

Documentation

The Bulk Service allows to execute a Bulk Command. This consists of two steps:

  • Creation of a document set by scrolling the database
  • Execution of a bulk on document set

Resolution Order

95
The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Start Order

2 (Declared Start Order: -600)
The start order represents the order in which this component has been started by the Nuxeo Runtime framework.
This number is interesting to tweak if your Java component interacts with other components, and needs to be started before or after another one.
It can be changed by implementing the method "Component#getApplicationStartedOrder()" on your Java component: components are sorted according to this reference value, in increasing order.
The default value is 1000, and the repository initialization uses number 100. Negative values can also be used.

Implementation

Class: org.nuxeo.ecm.core.bulk.BulkComponent

Services

Extension Points

XML Source

<?xml version="1.0"?>
<component name="org.nuxeo.ecm.core.bulk" version="1.0.0">

  <documentation>
    The Bulk Service allows to execute a Bulk Command. This consists of two steps:
    <ul>
      <li>Creation of a document set by scrolling the database</li>
      <li>Execution of a bulk on document set</li>
    </ul>
  </documentation>

  <implementation class="org.nuxeo.ecm.core.bulk.BulkComponent" />

  <service>
    <provide interface="org.nuxeo.ecm.core.bulk.BulkService" />
    <provide interface="org.nuxeo.ecm.core.bulk.BulkAdminService" />
  </service>

  <extension-point name="actions">
    <documentation>
      Allows to define the bulk actions.

      A bulk action is a stream processing composed of one or more computations.

      A bulk action can be made available through http APIs, default is false.

      The bucket size determines the number of document ids per record at the scroller level, default is 100.

      The batch size determines the number of document ids handled per transactions at the computation level, default is 25.

      <code>
        <extension target="org.nuxeo.ecm.core.bulk" point="actions">
          <action name="internalAction" bucketSize="100" batchSize="25" />
          <action name="publicAction" bucketSize="100" batchSize="25" httpEnabled="true" />
        </extension>
      </code>
    </documentation>
    <object class="org.nuxeo.ecm.core.bulk.BulkActionDescriptor" />
  </extension-point>

</component>