Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Edit description of flushc() #24

Merged
merged 1 commit into from
Jun 17, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ after connecting to Ingest channel you can call the following methods on it
| `->push(string $collection,string $bucket, string $object_id, string "data", [string <locale>])` | Add an item to index and Returns a Sonic Response, locale is optional, which should be a valid [ISO 639-3](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) locale (eng = English), if set to `none` lexing will be disabled |
| `->pop(string $collection,string $bucket, string $object_id, string "data"` | pops an item out of index and returns a Sonic Response |
| `->count(string $collection,[string $bucket, [string $object_id]]): int` | counts the number of items in collection, bucket or object |
| `->flushc(string $collection):int` | Flushes the buckets from a collection, returns a integer saying the number of items flushed |
| `->flushc(string $collection):int` | Flushes the objects from a collection, returns a integer saying the number of items flushed |
| `->flushb(string $collection, string $bucket):int` | Flushes the objects from a bucket, returns a integer saying the number of items flushed |
| `->flusho(string $collection, string $bucket, string $object_id):int` | Flushes the indexed text from an objects, returns a integer saying the number of items flushed |
| `->ping(): string` | Pings the server, should return _PONG_ |
Expand Down