Dagger
Search

elasticsearch

No long description provided.

Installation

dagger install github.com/mgreau/daggerverse/elasticsearch@v0.1.0

Entrypoint

Return Type
Elasticsearch !
Arguments
NameTypeDescription
ctrContainer An OCI-compatible container, also known as a Docker container.
versionString !No description provided
modeString !No description provided
javaOptsString !No description provided
curlContainer An OCI-compatible container, also known as a Docker container.
Example
func (m *myModule) example(version string, mode string, javaOpts string) *Elasticsearch  {
	return dag.
			Elasticsearch(version, mode, javaOpts)
}
@function
def example(version: str, mode: str, java_opts: str, ) -> dag.Elasticsearch:
	return (
		dag.elasticsearch(version, mode, java_opts)
	)
@func()
example(version: string, mode: string, javaOpts: string, ): Elasticsearch {
	return dag
		.elasticsearch(version, mode, javaOpts)
}

Types

Elasticsearch 🔗

ctr() 🔗

An OCI-compatible container, also known as a Docker container.

Return Type
Container !
Example
func (m *myModule) example(version string, mode string, javaOpts string) *Container  {
	return dag.
			Elasticsearch(version, mode, javaOpts).
			Ctr()
}
@function
def example(version: str, mode: str, java_opts: str, ) -> dagger.Container:
	return (
		dag.elasticsearch(version, mode, java_opts)
		.ctr()
	)
@func()
example(version: string, mode: string, javaOpts: string, ): Container {
	return dag
		.elasticsearch(version, mode, javaOpts)
		.ctr()
}

version() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context, version string, mode string, javaOpts string) string  {
	return dag.
			Elasticsearch(version, mode, javaOpts).
			Version(ctx)
}
@function
async def example(version: str, mode: str, java_opts: str, ) -> str:
	return await (
		dag.elasticsearch(version, mode, java_opts)
		.version()
	)
@func()
async example(version: string, mode: string, javaOpts: string, ): Promise<string> {
	return dag
		.elasticsearch(version, mode, javaOpts)
		.version()
}

mode() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context, version string, mode string, javaOpts string) string  {
	return dag.
			Elasticsearch(version, mode, javaOpts).
			Mode(ctx)
}
@function
async def example(version: str, mode: str, java_opts: str, ) -> str:
	return await (
		dag.elasticsearch(version, mode, java_opts)
		.mode()
	)
@func()
async example(version: string, mode: string, javaOpts: string, ): Promise<string> {
	return dag
		.elasticsearch(version, mode, javaOpts)
		.mode()
}

javaOpts() 🔗

Return Type
String !
Example
func (m *myModule) example(ctx context.Context, version string, mode string, javaOpts string) string  {
	return dag.
			Elasticsearch(version, mode, javaOpts).
			JavaOpts(ctx)
}
@function
async def example(version: str, mode: str, java_opts: str, ) -> str:
	return await (
		dag.elasticsearch(version, mode, java_opts)
		.java_opts()
	)
@func()
async example(version: string, mode: string, javaOpts: string, ): Promise<string> {
	return dag
		.elasticsearch(version, mode, javaOpts)
		.javaOpts()
}

service() 🔗

Create an Elasticsearch service in dev mode by default

Return Type
Service !
Arguments
NameTypeDefault ValueDescription
portInteger !9200No description provided
Example
func (m *myModule) example(version string, mode string, javaOpts string, port int) *Service  {
	return dag.
			Elasticsearch(version, mode, javaOpts).
			Service(port)
}
@function
def example(version: str, mode: str, java_opts: str, port: int) -> dagger.Service:
	return (
		dag.elasticsearch(version, mode, java_opts)
		.service(port)
	)
@func()
example(version: string, mode: string, javaOpts: string, port: number): Service {
	return dag
		.elasticsearch(version, mode, javaOpts)
		.service(port)
}

get() 🔗

Sends a GET request to the ES service and returns the response.

Return Type
String !
Arguments
NameTypeDefault ValueDescription
pathString !""No description provided
portInteger !9200No description provided
Example
func (m *myModule) example(ctx context.Context, version string, mode string, javaOpts string, path string, port int) string  {
	return dag.
			Elasticsearch(version, mode, javaOpts).
			Get(ctx, path, port)
}
@function
async def example(version: str, mode: str, java_opts: str, path: str, port: int) -> str:
	return await (
		dag.elasticsearch(version, mode, java_opts)
		.get(path, port)
	)
@func()
async example(version: string, mode: string, javaOpts: string, path: string, port: number): Promise<string> {
	return dag
		.elasticsearch(version, mode, javaOpts)
		.get(path, port)
}

delete() 🔗

Delete an Elasticsearch index.

Return Type
String !
Arguments
NameTypeDefault ValueDescription
indexString !""No description provided
portInteger !9200No description provided
Example
func (m *myModule) example(ctx context.Context, version string, mode string, javaOpts string, index string, port int) string  {
	return dag.
			Elasticsearch(version, mode, javaOpts).
			Delete(ctx, index, port)
}
@function
async def example(version: str, mode: str, java_opts: str, index: str, port: int) -> str:
	return await (
		dag.elasticsearch(version, mode, java_opts)
		.delete(index, port)
	)
@func()
async example(version: string, mode: string, javaOpts: string, index: string, port: number): Promise<string> {
	return dag
		.elasticsearch(version, mode, javaOpts)
		.delete(index, port)
}

indexData() 🔗

Index a document from a file into Elasticsearch.

Return Type
String !
Arguments
NameTypeDefault ValueDescription
dataFile !-A file.
indexString !"my-index"No description provided
portInteger !9200No description provided
Example
func (m *myModule) example(ctx context.Context, version string, mode string, javaOpts string, data *File, index string, port int) string  {
	return dag.
			Elasticsearch(version, mode, javaOpts).
			IndexData(ctx, data, index, port)
}
@function
async def example(version: str, mode: str, java_opts: str, data: dagger.File, index: str, port: int) -> str:
	return await (
		dag.elasticsearch(version, mode, java_opts)
		.index_data(data, index, port)
	)
@func()
async example(version: string, mode: string, javaOpts: string, data: File, index: string, port: number): Promise<string> {
	return dag
		.elasticsearch(version, mode, javaOpts)
		.indexData(data, index, port)
}

indexBulkData() 🔗

Index documents into Elasticsearch with the bulk API.

The data file should be in a format that is compatible with the Elasticsearch bulk API.

Doc: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html#docs-bulk

Return Type
String !
Arguments
NameTypeDefault ValueDescription
dataFile !-A file.
portInteger !9200No description provided
Example
func (m *myModule) example(ctx context.Context, version string, mode string, javaOpts string, data *File, port int) string  {
	return dag.
			Elasticsearch(version, mode, javaOpts).
			IndexBulkData(ctx, data, port)
}
@function
async def example(version: str, mode: str, java_opts: str, data: dagger.File, port: int) -> str:
	return await (
		dag.elasticsearch(version, mode, java_opts)
		.index_bulk_data(data, port)
	)
@func()
async example(version: string, mode: string, javaOpts: string, data: File, port: number): Promise<string> {
	return dag
		.elasticsearch(version, mode, javaOpts)
		.indexBulkData(data, port)
}

fullTextSearch() 🔗

Returns search hits that match the query defined in the request.

Return Type
String !
Arguments
NameTypeDefault ValueDescription
indexString !""No description provided
fieldString !""No description provided
queryString !""No description provided
portInteger !9200No description provided
Example
func (m *myModule) example(ctx context.Context, version string, mode string, javaOpts string, index string, field string, query string, port int) string  {
	return dag.
			Elasticsearch(version, mode, javaOpts).
			FullTextSearch(ctx, index, field, query, port)
}
@function
async def example(version: str, mode: str, java_opts: str, index: str, field: str, query: str, port: int) -> str:
	return await (
		dag.elasticsearch(version, mode, java_opts)
		.full_text_search(index, field, query, port)
	)
@func()
async example(version: string, mode: string, javaOpts: string, index: string, field: string, query: string, port: number): Promise<string> {
	return dag
		.elasticsearch(version, mode, javaOpts)
		.fullTextSearch(index, field, query, port)
}