generated from jCloud/repository-template
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
# jeb-server-utils
|
|
|
|
The utilities for the jeb server.
|
|
|
|
## Warning
|
|
|
|
This library is deprecated. Use [jeb-core](https://gitea.jcloud-services.ddns.net/jCloud/jeb-core) instead
|
|
|
|
## Installation
|
|
You can install the library using `pip`:
|
|
|
|
```bash
|
|
pip install jeb-server-utils --index-url https://repo.jcloud-services.ddns.net/simple/ --extra-index-url https://pypi.org/simple
|
|
```
|
|
|
|
## Usage
|
|
### `JEBServerUtils`
|
|
The main class. It has following methods:
|
|
- `get_segment_base_timestamp`: Returns the base timestamp of a segment.
|
|
- `get_topics`: Returns all topics.
|
|
- `mktopic`: Creates a topic.
|
|
- `rmtopic`: Removes a topic.
|
|
- `mktopicpart`: Creates a partition of a topic.
|
|
- `rmtopicpart`: Removes a partition of a topic.
|
|
- `check_topic_exists`: Checks whether a topic exists (raises an exception if not).
|
|
- `create_record`: Creates a record.
|
|
- `fetch_records`: Fetches records from the topic and yields them in chunks.
|
|
|
|
### `Topic`
|
|
A topic.
|
|
|
|
### `Segment`:
|
|
A segment.
|
|
|
|
For more details, see the function and method docstrings.
|
|
|
|
## Changelog
|
|
|
|
### Version 0.2.0
|
|
- marked as deprecated
|
|
|
|
### Version 0.1.2
|
|
- Bug fix
|
|
|
|
### Version 0.1.1
|
|
- Bug fix: `__init__.py` tried to import from `_core` instead of `._core`.
|
|
|
|
### Version 0.1.0
|
|
- First release |