Application

Configuration

As with all data stores, this data store maintain a configuration document that contains system and custom properties. You can write your own properties onto this configuration document if you wish. You might use those properties to query and retrieve the directory at a later time.

Some system properties are read-only and others are writable. You can adjust the writable properties to modify the behavior and characteristics of the directory.

Data Store Properties

Any system properties that are shown to be Read-Only are not modifiable on calls to create() or update(). Anything else is fair game.

Property

Type

Default

Read-Only

Description

title

text

The title of the data store.

description

text

A description for the data store.

enableAuthorities

boolean

true

If true, the data store will check whether the current principal has rights to perform an operation against content upon interaction. If turned off, you'll see some performance benefits. This should only ever be switched off for "published" or general availability content and never for authoring-side content.

enableAuditing

boolean

false

If true, then the data store will collect audit records for all service-level operations (such as CRUD operations). This incurs a slight performance penalty but guarantees you a record of all interactions with data for changesets, branches and nodes in the data store.

locked

boolean

false

Read-only

Whether the data store is presently locked. If the data store is locked, then write operations against it will block.

lockedBy

text

Read-only

The principal that holds the lock (if the data store is locked).

size

number

0

Read-only

The last-recorded allocation size (on disk) of the data store in bytes. This value is updated periodically and may not be precise at the moment it is read.

maxsize

number

-1

The maximum allowed allocation size (on disk) of the data store in bytes. If this size of the data store exceeds this value, write operations will fail. A value of -1 indicates that there is no upper limit.

objectcount

number

0

Read-only

The number of objects stored within the data store. This includes system-maintained objects. This value is updated periodically and may not be precise at the moment it is read.

statisticsDate

timestamp

Read-only

Records the time when statistics were last run against the data store. Statistics are run periodically to calculate the data store size and object allocations.

statisticsDirty

boolean

false

Read-only

Whether writes have occurred against this data store since the last time statistics were run. This signals to the system that statistics need to be collected at the next available opportunity.

Create an Application

You can create an empty application like this:

platform.createApplication();

Or you can pass in configuration which will be applied to the application. You can pass in any properties you'd like. These properties will become part of the application configuration and you can utilize that however you'd like.

Granted, in many cases you won't know the application ID off-hand. You'll likely need to look up the application ID ahead of time by some other means. Read further on this page for examples of how you can do this.

List Applications

You can retrieve a list of applications for your platform quite easily. The following code hands back the full list.

Retrieving the full list is potentially an expensive operation, depending how many applications you have. The more your retrieve, the more data goes over the wire and so forth. Thus, you might wish to paginate your call and retrieve a subset of the total list at a time.

Here is an example that retrieves in pages of size 10. It starts on the second page (by skipping to starting index 20). It also sorts by the title field in a descending sequence.

Finally, you can mix queries with pagination to reduce data over the wire and speed up performance. Here is that same query with some pagination thrown in. We limit to pages of size 10 and sort by title.