HandlesDocuments
Table of Contents
Methods
-
addDocuments()
: mixed
-
addDocumentsCsv()
: mixed
-
addDocumentsCsvInBatches()
: mixed
-
addDocumentsInBatches()
: mixed
-
addDocumentsJson()
: mixed
-
addDocumentsNdjson()
: mixed
-
addDocumentsNdjsonInBatches()
: mixed
-
deleteAllDocuments()
: array<string|int, mixed>
-
deleteDocument()
: array<string|int, mixed>
-
deleteDocuments()
: array<string|int, mixed>
-
getDocument()
: mixed
-
getDocuments()
: DocumentsResults
-
updateDocuments()
: mixed
-
updateDocumentsCsv()
: mixed
-
updateDocumentsCsvInBatches()
: mixed
-
updateDocumentsInBatches()
: mixed
-
updateDocumentsJson()
: mixed
-
updateDocumentsNdjson()
: mixed
-
updateDocumentsNdjsonInBatches()
: mixed
-
assertValidDocumentId()
: void
-
batch()
: Generator
-
batchCsvString()
: Generator
-
batchNdjsonString()
: Generator
addDocuments()
public
addDocuments(array<string|int, mixed> $documents[, string|null $primaryKey = null ]) : mixed
Parameters
-
$documents
: array<string|int, mixed>
-
-
$primaryKey
: string|null
= null
-
addDocumentsCsv()
public
addDocumentsCsv(string $documents[, string|null $primaryKey = null ][, string|null $delimiter = null ]) : mixed
Parameters
-
$documents
: string
-
-
$primaryKey
: string|null
= null
-
-
$delimiter
: string|null
= null
-
addDocumentsCsvInBatches()
public
addDocumentsCsvInBatches(string $documents[, int|null $batchSize = 1000 ][, string|null $primaryKey = null ][, string|null $delimiter = null ]) : mixed
Parameters
-
$documents
: string
-
-
$batchSize
: int|null
= 1000
-
-
$primaryKey
: string|null
= null
-
-
$delimiter
: string|null
= null
-
addDocumentsInBatches()
public
addDocumentsInBatches(array<string|int, mixed> $documents[, int|null $batchSize = 1000 ][, string|null $primaryKey = null ]) : mixed
Parameters
-
$documents
: array<string|int, mixed>
-
-
$batchSize
: int|null
= 1000
-
-
$primaryKey
: string|null
= null
-
addDocumentsJson()
public
addDocumentsJson(string $documents[, string|null $primaryKey = null ]) : mixed
Parameters
-
$documents
: string
-
-
$primaryKey
: string|null
= null
-
addDocumentsNdjson()
public
addDocumentsNdjson(string $documents[, string|null $primaryKey = null ]) : mixed
Parameters
-
$documents
: string
-
-
$primaryKey
: string|null
= null
-
addDocumentsNdjsonInBatches()
public
addDocumentsNdjsonInBatches(string $documents[, int|null $batchSize = 1000 ][, string|null $primaryKey = null ]) : mixed
Parameters
-
$documents
: string
-
-
$batchSize
: int|null
= 1000
-
-
$primaryKey
: string|null
= null
-
deleteAllDocuments()
public
deleteAllDocuments() : array<string|int, mixed>
Return values
array<string|int, mixed>
deleteDocument()
public
deleteDocument(mixed $documentId) : array<string|int, mixed>
Parameters
-
$documentId
: mixed
-
Return values
array<string|int, mixed>
deleteDocuments()
public
deleteDocuments(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
-
$options
: array<string|int, mixed>
-
Return values
array<string|int, mixed>
getDocument()
public
getDocument(mixed $documentId[, array<string|int, mixed>|null $fields = null ]) : mixed
Parameters
-
$documentId
: mixed
-
-
$fields
: array<string|int, mixed>|null
= null
-
getDocuments()
public
getDocuments([DocumentsQuery|null $options = null ]) : DocumentsResults
Parameters
-
$options
: DocumentsQuery|null
= null
-
updateDocuments()
public
updateDocuments(array<string|int, mixed> $documents[, string|null $primaryKey = null ]) : mixed
Parameters
-
$documents
: array<string|int, mixed>
-
-
$primaryKey
: string|null
= null
-
updateDocumentsCsv()
public
updateDocumentsCsv(string $documents[, string|null $primaryKey = null ][, string|null $delimiter = null ]) : mixed
Parameters
-
$documents
: string
-
-
$primaryKey
: string|null
= null
-
-
$delimiter
: string|null
= null
-
updateDocumentsCsvInBatches()
public
updateDocumentsCsvInBatches(string $documents[, int|null $batchSize = 1000 ][, string|null $primaryKey = null ][, string|null $delimiter = null ]) : mixed
Parameters
-
$documents
: string
-
-
$batchSize
: int|null
= 1000
-
-
$primaryKey
: string|null
= null
-
-
$delimiter
: string|null
= null
-
updateDocumentsInBatches()
public
updateDocumentsInBatches(array<string|int, mixed> $documents[, int|null $batchSize = 1000 ][, string|null $primaryKey = null ]) : mixed
Parameters
-
$documents
: array<string|int, mixed>
-
-
$batchSize
: int|null
= 1000
-
-
$primaryKey
: string|null
= null
-
updateDocumentsJson()
public
updateDocumentsJson(string $documents[, string|null $primaryKey = null ]) : mixed
Parameters
-
$documents
: string
-
-
$primaryKey
: string|null
= null
-
updateDocumentsNdjson()
public
updateDocumentsNdjson(string $documents[, string|null $primaryKey = null ]) : mixed
Parameters
-
$documents
: string
-
-
$primaryKey
: string|null
= null
-
updateDocumentsNdjsonInBatches()
public
updateDocumentsNdjsonInBatches(string $documents[, int|null $batchSize = 1000 ][, string|null $primaryKey = null ]) : mixed
Parameters
-
$documents
: string
-
-
$batchSize
: int|null
= 1000
-
-
$primaryKey
: string|null
= null
-
assertValidDocumentId()
private
assertValidDocumentId(mixed $documentId) : void
Parameters
-
$documentId
: mixed
-
batch()
private
static batch(array<string|int, mixed> $documents, int $batchSize) : Generator
Parameters
-
$documents
: array<string|int, mixed>
-
-
$batchSize
: int
-
batchCsvString()
private
static batchCsvString(string $documents, int $batchSize) : Generator
Parameters
-
$documents
: string
-
-
$batchSize
: int
-
batchNdjsonString()
private
static batchNdjsonString(string $documents, int $batchSize) : Generator
Parameters
-
$documents
: string
-
-
$batchSize
: int
-