Module wse

Scalable "Search Engine" for WARC files using Elastic Search.

Copyright 2010-2014 ALEPH ARCHIVES Ltd. All rights reserved.

Version: 1.0

Authors: Aleph Archives Ltd. [web site: http://aleph-archives.com/].

Description

Scalable "Search Engine" for WARC files using Elastic Search

Function Index

async_index/1Indexes a WARC file asynchronously.
index/1Indexes a WARC file synchronously.
restart/0handy shortcut to restart the application while it's running.
revision/0Returns the current revision number.
start/0Equivalent to application:start(wse).
status/0Returns whether the WSE index server can accept more WARC files to index, or not (busy).
stop/0Equivalent to application:stop(wse).
version/0Returns the current version number.

Function Details

async_index/1

async_index(WarcPath::string()) -> ok | {error, any()}

Indexes a WARC file asynchronously.

index/1

index(WarcPath::string()) -> ok | {error, any()}

Indexes a WARC file synchronously.

restart/0

restart() -> ok

handy shortcut to restart the application while it's running

revision/0

revision() -> string()

Returns the current revision number.

start/0

start() -> ok

Equivalent to application:start(wse).

status/0

status() -> ok | busy

Returns whether the WSE index server can accept more WARC files to index, or not (busy).

stop/0

stop() -> ok

Equivalent to application:stop(wse).

version/0

version() -> string()

Returns the current version number.


Generated by EDoc, May 27 2014, 18:01:08.