---
title: Local Backend
description: This is an abstract object type that cannot be instantiated.
component: pingds
version: 8.1
page_id: pingds:configref:objects-local-backend
canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-local-backend.html
section_ids:
  local_backends: Local Backends
  parent: Parent
  local_backend_properties: Local Backend properties
  basic_properties: Basic properties
  backend-id: backend-id
  enabled: enabled
  java-class: java-class
  writability-mode: writability-mode
---

# Local Backend

*This is an abstract object type that cannot be instantiated.*

Local Backends are responsible for providing access to the underlying data presented by the server.

The data may be stored locally in an embedded database, remotely in an external system, or generated on the fly (for example, calculated from other information that is available).

## Local Backends

The following Local Backends are available:

* [LDIF Backend](objects-ldif-backend.html)

* [Memory Backend](objects-memory-backend.html)

* [Monitor Backend](objects-monitor-backend.html)

* [Null Backend](objects-null-backend.html)

* [Pluggable Backend](objects-pluggable-backend.html)

* [Schema Backend](objects-schema-backend.html)

* [Task Backend](objects-task-backend.html)

These Local Backends inherit the properties described below.

## Parent

The Local Backend object inherits from [Backend](objects-backend.html).

## Local Backend properties

You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html).

| Basic Properties                                                                                              |
| ------------------------------------------------------------------------------------------------------------- |
| [backend-id](#backend-id) [enabled](#enabled) [java-class](#java-class) [writability-mode](#writability-mode) |

### Basic properties

Use the `--advanced` option to access advanced properties.

### backend-id

|                         |                                                                                                                                                                                                      |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | Specifies a name to identify the associated backend.                                                                                                                                                 |
| *Description*           | The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.                                                              |
| *Default value*         | None                                                                                                                                                                                                 |
| *Allowed values*        | A string.                                                                                                                                                                                            |
| *Multi-valued*          | No                                                                                                                                                                                                   |
| *Required*              | Yes                                                                                                                                                                                                  |
| *Admin action required* | NoneNo base entry has been created as part of this process. A base entry needs to be created before adding further entries to the backend. Please refer to the documentation to create a base entry. |
| *Advanced*              | No                                                                                                                                                                                                   |
| *Read-only*             | Yes                                                                                                                                                                                                  |

### enabled

|                         |                                                                                               |
| ----------------------- | --------------------------------------------------------------------------------------------- |
| *Synopsis*              | Indicates whether the backend is enabled in the server.                                       |
| *Description*           | If a backend is not enabled, then its contents are not accessible when processing operations. |
| *Default value*         | None                                                                                          |
| *Allowed values*        | truefalse                                                                                     |
| *Multi-valued*          | No                                                                                            |
| *Required*              | Yes                                                                                           |
| *Admin action required* | None                                                                                          |
| *Advanced*              | No                                                                                            |
| *Read-only*             | No                                                                                            |

### java-class

|                         |                                                                                                |
| ----------------------- | ---------------------------------------------------------------------------------------------- |
| *Synopsis*              | Specifies the fully-qualified name of the Java class that provides the backend implementation. |
| *Default value*         | None                                                                                           |
| *Allowed values*        | A Java class that extends or implements:- org.opends.server.api.Backend                        |
| *Multi-valued*          | No                                                                                             |
| *Required*              | Yes                                                                                            |
| *Admin action required* | The object must be disabled and re-enabled for changes to take effect.                         |
| *Advanced*              | No                                                                                             |
| *Read-only*             | No                                                                                             |

### writability-mode

|                         |                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | Specifies the behavior that the backend should use when processing write operations.                                                                                                                                                                                                                                                                                                                                                        |
| *Default value*         | None                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| *Allowed values*        | * disabled: Causes all write attempts to fail.

* enabled: Allows write operations to be performed in that backend (if the requested operation is valid, the user has permission to perform the operation, the backend supports that type of write operation, and the global writability-mode property is also enabled).

* internal-only: Causes external write attempts to fail but allows writes by replication and internal operations. |
| *Multi-valued*          | No                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| *Required*              | Yes                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| *Admin action required* | None                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| *Advanced*              | No                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| *Read-only*             | No                                                                                                                                                                                                                                                                                                                                                                                                                                          |