Skip to content

Update Documentation #1008

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update Documentation #1008

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/api-reference/quixstreams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3965,7 +3965,7 @@ Optional[ConfigurationVersion]: The valid version, or None if not found.
class Lookup(BaseLookup[BaseField])
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/quix_configuration_service/lookup.py#L38)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/quix_configuration_service/lookup.py#L39)

Lookup join implementation for enriching streaming data with configuration data from a Kafka topic.

Expand Down Expand Up @@ -4001,7 +4001,7 @@ def json_field(jsonpath: str,
default: Any = RAISE_ON_MISSING) -> JSONField
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/quix_configuration_service/lookup.py#L123)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/quix_configuration_service/lookup.py#L136)

Create a JSON field for extracting values from configuration content using JSONPath.

Expand All @@ -4024,7 +4024,7 @@ A JSONField instance.
def bytes_field(type: str, default: Any = RAISE_ON_MISSING) -> BytesField
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/quix_configuration_service/lookup.py#L147)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/quix_configuration_service/lookup.py#L160)

Create a bytes field for extracting binary content from configuration.

Expand All @@ -4045,7 +4045,7 @@ A BytesField instance.
def cache_info() -> CacheInfo
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/quix_configuration_service/lookup.py#L367)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/quix_configuration_service/lookup.py#L380)

Get information about the cache.

Expand All @@ -4065,7 +4065,7 @@ def join(fields: Mapping[str, BaseField], on: str, value: dict[str, Any],
key: Any, timestamp: int, headers: HeadersMapping) -> None
```

[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/quix_configuration_service/lookup.py#L379)
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/quix_configuration_service/lookup.py#L392)

Enrich the message with configuration data from the Quix Configuration Service.

Expand Down