Module

Yoga.Elasticsearch.Elasticsearch

Package: purescript-yoga-elasticsearch
Repository: rowtype-yoga/purescript-yoga-elasticsearch

#Client Source

data Client

#Node Source

newtype Node

Constructors

Node String

Instances

#ApiKeyId Source

newtype ApiKeyId

Constructors

ApiKeyId String

Instances

#ApiKeySecret Source

newtype ApiKeySecret

Constructors

ApiKeySecret String

Instances

#Username Source

newtype Username

Constructors

Username String

Instances

#Password Source

newtype Password

Constructors

Password String

Instances

#BearerToken Source

newtype BearerToken

Constructors

BearerToken String

Instances

#CloudId Source

newtype CloudId

Constructors

CloudId String

Instances

#RequestTimeout Source

newtype RequestTimeout

Constructors

RequestTimeout Milliseconds

Instances

#MaxRetries Source

newtype MaxRetries

Constructors

MaxRetries Int

Instances

#IndexName Source

newtype IndexName

Constructors

IndexName String

Instances

#DocumentId Source

newtype DocumentId

Constructors

DocumentId String

Instances

#Routing Source

newtype Routing

Constructors

Routing String

Instances

#RefreshPolicy Source

newtype RefreshPolicy

Constructors

RefreshPolicy String

Instances

#refreshTrue Source

refreshTrue :: RefreshPolicy

#refreshFalse Source

refreshFalse :: RefreshPolicy

#refreshWaitFor Source

refreshWaitFor :: RefreshPolicy

#ScrollId Source

newtype ScrollId

Constructors

ScrollId String

Instances

#ScrollTimeout Source

newtype ScrollTimeout

Constructors

ScrollTimeout String

Instances

#ClusterName Source

newtype ClusterName

Constructors

ClusterName String

Instances

#ClusterUUID Source

newtype ClusterUUID

Constructors

ClusterUUID String

Instances

#Version Source

newtype Version

Constructors

Version String

Instances

#BuildHash Source

newtype BuildHash

Constructors

BuildHash String

Instances

#Document Source

newtype Document

Constructors

Document Foreign

Instances

Newtype Document _

#Query Source

newtype Query

Constructors

Query Foreign

Instances

Newtype Query _

#Script Source

newtype Script

Constructors

Script Foreign

Instances

Newtype Script _

#Mappings Source

newtype Mappings

Constructors

Mappings Foreign

Instances

Newtype Mappings _

#Settings Source

newtype Settings

Constructors

Settings Foreign

Instances

Newtype Settings _

#Sort Source

newtype Sort

Constructors

Sort Foreign

Instances

Newtype Sort _

#DocumentVersion Source

newtype DocumentVersion

Constructors

DocumentVersion Int

Instances

#SequenceNumber Source

newtype SequenceNumber

Constructors

SequenceNumber Int

Instances

#PrimaryTerm Source

newtype PrimaryTerm

Constructors

PrimaryTerm Int

Instances

#IndexResult Source

newtype IndexResult

Constructors

IndexResult String

Instances

#ShardCount Source

newtype ShardCount

Constructors

ShardCount Int

Instances

#ShardInfo Source

type ShardInfo = { failed :: ShardCount, successful :: ShardCount, total :: ShardCount }

#Score Source

newtype Score

Constructors

Score Number

Instances

#TookMilliseconds Source

newtype TookMilliseconds

Constructors

TookMilliseconds Int

Instances

#HitCount Source

newtype HitCount

Constructors

HitCount Int

Instances

#SkippedCount Source

newtype SkippedCount

Constructors

SkippedCount Int

Instances

#RetryCount Source

newtype RetryCount

Constructors

RetryCount Int

Instances

#FromOffset Source

newtype FromOffset

Constructors

FromOffset Int

Instances

#ResultSize Source

newtype ResultSize

Constructors

ResultSize Int

Instances

#ApiKeyAuth Source

type ApiKeyAuth = { api_key :: ApiKeySecret, id :: ApiKeyId }

#BasicAuth Source

type BasicAuth = { password :: Password, username :: Username }

#ClientConfigImpl Source

type ClientConfigImpl :: Row Typetype ClientConfigImpl = (auth :: { apiKey :: ApiKeyAuth }, basicAuth :: BasicAuth, bearerToken :: BearerToken, cloud :: { id :: CloudId }, compression :: Boolean, maxRetries :: MaxRetries, node :: Node, nodes :: Array Node, requestTimeout :: RequestTimeout, ssl :: { rejectUnauthorized :: Boolean })

#createClientImpl Source

createClientImpl :: forall opts. EffectFn1 (Record opts) Client

#createClient Source

createClient :: forall opts opts_. Union opts opts_ ClientConfigImpl => Record opts -> Effect Client

#ClusterInfo Source

type ClusterInfo = { cluster_name :: ClusterName, cluster_uuid :: ClusterUUID, name :: ClusterName, tagline :: String, version :: { build_date :: String, build_flavor :: String, build_hash :: BuildHash, build_snapshot :: Boolean, build_type :: String, lucene_version :: Version, minimum_index_compatibility_version :: Version, minimum_wire_compatibility_version :: Version, number :: Version } }

#infoImpl Source

infoImpl :: EffectFn1 Client (Promise ClusterInfo)

#info Source

info :: Client -> Aff ClusterInfo

#pingImpl Source

pingImpl :: EffectFn1 Client (Promise Boolean)

#ping Source

ping :: Client -> Aff Boolean

#CreateIndexOptionsImpl Source

type CreateIndexOptionsImpl :: Row Typetype CreateIndexOptionsImpl = (mappings :: Mappings, settings :: Settings)

#CreateIndexResponse Source

type CreateIndexResponse = { acknowledged :: Boolean, index :: IndexName, shards_acknowledged :: Boolean }

#createIndexImpl Source

createIndexImpl :: forall opts. EffectFn3 Client IndexName (Record opts) (Promise CreateIndexResponse)

#createIndex Source

createIndex :: forall opts opts_. Union opts opts_ CreateIndexOptionsImpl => IndexName -> Record opts -> Client -> Aff CreateIndexResponse

#DeleteIndexResponse Source

type DeleteIndexResponse = { acknowledged :: Boolean }

#deleteIndexImpl Source

deleteIndexImpl :: EffectFn2 Client IndexName (Promise DeleteIndexResponse)

#deleteIndex Source

deleteIndex :: IndexName -> Client -> Aff DeleteIndexResponse

#indexExistsImpl Source

indexExistsImpl :: EffectFn2 Client IndexName (Promise Boolean)

#indexExists Source

indexExists :: IndexName -> Client -> Aff Boolean

#IndexDocumentOptionsImpl Source

type IndexDocumentOptionsImpl :: Row Typetype IndexDocumentOptionsImpl = (id :: DocumentId, refresh :: RefreshPolicy, routing :: Routing, timeout :: RequestTimeout)

#IndexDocumentResponse Source

type IndexDocumentResponse = { _id :: DocumentId, _index :: IndexName, _shards :: ShardInfo, _version :: DocumentVersion, result :: IndexResult }

#indexDocumentImpl Source

indexDocumentImpl :: forall opts. EffectFn4 Client IndexName Document (Record opts) (Promise IndexDocumentResponse)

#indexDocument Source

indexDocument :: forall opts opts_. Union opts opts_ IndexDocumentOptionsImpl => IndexName -> Document -> Record opts -> Client -> Aff IndexDocumentResponse

#GetDocumentOptionsImpl Source

type GetDocumentOptionsImpl :: Row Typetype GetDocumentOptionsImpl = (_source :: Boolean, _source_excludes :: Array String, _source_includes :: Array String, routing :: Routing)

#GetDocumentResponse Source

type GetDocumentResponse = { _id :: DocumentId, _index :: IndexName, _primary_term :: PrimaryTerm, _seq_no :: SequenceNumber, _source :: Nullable Foreign, _version :: DocumentVersion, found :: Boolean }

#getDocumentImpl Source

getDocumentImpl :: forall opts. EffectFn4 Client IndexName DocumentId (Record opts) (Promise GetDocumentResponse)

#getDocument Source

getDocument :: forall opts opts_. Union opts opts_ GetDocumentOptionsImpl => IndexName -> DocumentId -> Record opts -> Client -> Aff GetDocumentResponse

#getDocumentMaybe Source

getDocumentMaybe :: IndexName -> DocumentId -> Client -> Aff (Maybe Foreign)

#UpdateDocumentOptionsImpl Source

type UpdateDocumentOptionsImpl :: Row Typetype UpdateDocumentOptionsImpl = (doc :: Document, refresh :: RefreshPolicy, retry_on_conflict :: RetryCount, routing :: Routing, script :: Script)

#UpdateDocumentResponse Source

type UpdateDocumentResponse = { _id :: DocumentId, _index :: IndexName, _version :: DocumentVersion, result :: IndexResult }

#updateDocumentImpl Source

updateDocumentImpl :: forall opts. EffectFn4 Client IndexName DocumentId (Record opts) (Promise UpdateDocumentResponse)

#updateDocument Source

updateDocument :: forall opts opts_. Union opts opts_ UpdateDocumentOptionsImpl => IndexName -> DocumentId -> Record opts -> Client -> Aff UpdateDocumentResponse

#DeleteDocumentOptionsImpl Source

type DeleteDocumentOptionsImpl :: Row Typetype DeleteDocumentOptionsImpl = (refresh :: RefreshPolicy, routing :: Routing)

#DeleteDocumentResponse Source

type DeleteDocumentResponse = { _id :: DocumentId, _index :: IndexName, _version :: DocumentVersion, result :: IndexResult }

#deleteDocumentImpl Source

deleteDocumentImpl :: forall opts. EffectFn4 Client IndexName DocumentId (Record opts) (Promise DeleteDocumentResponse)

#deleteDocument Source

deleteDocument :: forall opts opts_. Union opts opts_ DeleteDocumentOptionsImpl => IndexName -> DocumentId -> Record opts -> Client -> Aff DeleteDocumentResponse

#SearchOptionsImpl Source

type SearchOptionsImpl :: Row Typetype SearchOptionsImpl = (_source :: Boolean, _source_excludes :: Array String, _source_includes :: Array String, from :: FromOffset, query :: Query, routing :: Routing, scroll :: ScrollTimeout, size :: ResultSize, sort :: Sort, track_total_hits :: Boolean)

#SearchHit Source

type SearchHit = { _id :: DocumentId, _index :: IndexName, _score :: Nullable Score, _source :: Foreign }

#SearchResponse Source

type SearchResponse = { _scroll_id :: Nullable ScrollId, _shards :: { failed :: ShardCount, skipped :: SkippedCount, successful :: ShardCount, total :: ShardCount }, hits :: { hits :: Array SearchHit, max_score :: Nullable Score, total :: { relation :: String, value :: HitCount } }, timed_out :: Boolean, took :: TookMilliseconds }

#searchImpl Source

searchImpl :: forall opts. EffectFn3 Client (Nullable IndexName) (Record opts) (Promise SearchResponse)

#search Source

search :: forall opts opts_. Union opts opts_ SearchOptionsImpl => Maybe IndexName -> Record opts -> Client -> Aff SearchResponse

#searchAll Source

searchAll :: forall opts opts_. Union opts opts_ SearchOptionsImpl => Record opts -> Client -> Aff SearchResponse

#ScrollOptionsImpl Source

type ScrollOptionsImpl :: Row Typetype ScrollOptionsImpl = (scroll :: ScrollTimeout)

#scrollImpl Source

scrollImpl :: forall opts. EffectFn3 Client ScrollId (Record opts) (Promise SearchResponse)

#scroll Source

scroll :: forall opts opts_. Union opts opts_ ScrollOptionsImpl => ScrollId -> Record opts -> Client -> Aff SearchResponse

#clearScrollImpl Source

clearScrollImpl :: EffectFn2 Client ScrollId (Promise { succeeded :: Boolean })

#clearScroll Source

clearScroll :: ScrollId -> Client -> Aff { succeeded :: Boolean }

#BulkOperation Source

type BulkOperation = Foreign

#BulkResponse Source

type BulkResponse = { errors :: Boolean, items :: Array Foreign, took :: TookMilliseconds }

#bulkImpl Source

bulkImpl :: EffectFn2 Client (Array BulkOperation) (Promise BulkResponse)

#bulk Source

bulk :: Array BulkOperation -> Client -> Aff BulkResponse

#CountOptionsImpl Source

type CountOptionsImpl :: Row Typetype CountOptionsImpl = (query :: Query)

#CountResponse Source

type CountResponse = { count :: HitCount }

#countImpl Source

countImpl :: forall opts. EffectFn3 Client (Nullable IndexName) (Record opts) (Promise CountResponse)

#count Source

count :: forall opts opts_. Union opts opts_ CountOptionsImpl => Maybe IndexName -> Record opts -> Client -> Aff CountResponse

#refreshImpl Source

refreshImpl :: EffectFn2 Client IndexName (Promise { _shards :: ShardInfo })

#refresh Source

refresh :: IndexName -> Client -> Aff { _shards :: ShardInfo }

#closeImpl Source

closeImpl :: EffectFn1 Client (Promise Unit)

#close Source

close :: Client -> Aff Unit

Modules: Yoga.Elasticsearch.Elasticsearch