Show Table of Contents
14.13. Slapi_Backend
Represents a backend operation in the server plug-in-in.
Syntax
#include "slapi-plugin.h" typedef struct backend Slapi_Backend;
Description
Slapi_Backend is the data type for an opaque structure that represents a backend operation. The following table summarizes the front-end API functions that you can call to work with the backend operations.
| To... | ... Call this function |
|---|---|
| Add the specified suffix to the given backend and increment the backend's suffix count. | slapi_be_addsuffix() |
| Set the flag to denote that the backend will be deleted on exiting. | slapi_be_delete_onexit() |
| Check if the backend that contains the specified DN exists. | slapi_be_exist() |
| Free memory and linked resources from the backend structure. | slapi_be_free() |
| Get the instance information of the specified backend. | slapi_be_get_instance_info() |
| Return the name of the specified backend. | slapi_be_get_name() |
| Indicate if the database associated with the backend is in read-only mode. | slapi_be_get_readonly() |
| Get pointer to a callback function that corresponds to the specified entry point into a given backend. | slapi_be_getentrypoint() |
| Return the n+1 suffix associated with the specified backend. | slapi_be_getsuffix() |
| Return the type of the backend. | slapi_be_gettype() |
| Check if a flag is set in the backend configuration. | slapi_be_is_flag_set() |
| Verify that the specified suffix matches a registered backend suffix. | slapi_be_issuffix() |
| Indicate if the changes applied to the backend should be logged in the changelog. | slapi_be_logchanges() |
| Create a new backend structure, allocate memory for it, and initialize values for relevant parameters. | slapi_be_new() |
| Verify if the backend is private. | slapi_be_private() |
| Find the backend that should be used to service the entry with the specified DN. | slapi_be_select() |
| Find the backend that matches by the name of the backend. Backends can be identified by name and type. | slapi_be_select_by_instance_name() |
| Set the specified flag in the backend. | slapi_be_set_flag() |
| Set the instance information of the specified backend with given data. | slapi_be_set_instance_info() |
| Set a flag to denote that the backend is meant to be read-only. | slapi_be_set_readonly() |
| Set the entry point in the backend to the specified function. | slapi_be_setentrypoint() |
| Return a pointer to the backend structure of the first backend. | slapi_get_first_backend() |
| Return a pointer to the next backend, selected by index. | slapi_get_next_backend() |
| Return the first root suffix of the DIT. | slapi_get_first_suffix() |
| Return the DN of the next root suffix of the DIT. | slapi_get_next_suffix() |
| Check if a suffix is a root suffix of the DIT. | slapi_is_root_suffix() |
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.