aboutsummaryrefslogtreecommitdiff
path: root/lib/notmuch.h
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2021-01-01 20:43:14 -0400
committerDavid Bremner <david@tethera.net>2021-02-06 19:48:34 -0400
commitac67cd84eea1148680ab3a377d35ae346073f138 (patch)
treec236c0ce222841a35e835ba4843d96b2964078b2 /lib/notmuch.h
parent55f5e87096fda96280ccc4b191393c7e59b4df57 (diff)
lib: introduce notmuch_database_create_with_config
This takes a config path parameter, and can use that to decide the new database location.
Diffstat (limited to 'lib/notmuch.h')
-rw-r--r--lib/notmuch.h27
1 files changed, 27 insertions, 0 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h
index 6d22d328..5e07a01a 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -442,6 +442,33 @@ notmuch_database_open_with_config (const char *database_path,
const char *profile,
notmuch_database_t **database,
char **error_message);
+/**
+ * Create a new notmuch database located at 'database_path', using
+ * configuration in 'config_path'.
+ *
+ * For description of arguments, @see notmuch_database_open_with_config
+ *
+ * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
+ *
+ * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created
+ *
+ * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
+ *
+ * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
+ * database or config file (such as permission denied, or file not found,
+ * etc.)
+ *
+ * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
+ *
+ * @since libnotmuch 5.4 (notmuch 0.32)
+ */
+
+notmuch_status_t
+notmuch_database_create_with_config (const char *database_path,
+ const char *config_path,
+ const char *profile,
+ notmuch_database_t **database,
+ char **error_message);
/**
* Retrieve last status string for given database.