Skip to content

Commit cad77e0

Browse files
github-actions[bot]daniil-quix
github-actions[bot]
and
daniil-quix
authored
Update documentation (#960)
Co-authored-by: daniil-quix <[email protected]>
1 parent 4593332 commit cad77e0

File tree

2 files changed

+28
-28
lines changed

2 files changed

+28
-28
lines changed

‎docs/api-reference/dataframe.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2679,7 +2679,7 @@ A dictionary containing cache statistics: hits, misses, size, maxsize.
26792679
class BasePostgresLookupField(BaseField, abc.ABC)
26802680
```
26812681

2682-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L25)
2682+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L31)
26832683

26842684
<a id="quixstreams.dataframe.joins.lookups.postgresql.BasePostgresLookupField.build_query"></a>
26852685

@@ -2694,7 +2694,7 @@ def build_query(
26942694
) -> Tuple[sql.Composable, Union[dict[str, Any], Tuple[str, ...]]]
26952695
```
26962696

2697-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L32)
2697+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L38)
26982698

26992699
Build the SQL query string for this field.
27002700

@@ -2722,7 +2722,7 @@ A tuple of the SQL query string and the parameters.
27222722
def result(cursor: pg_cursor) -> Union[dict[str, Any], list[dict[str, Any]]]
27232723
```
27242724

2725-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L46)
2725+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L52)
27262726

27272727
Extract the result from the cursor based on the field definition.
27282728

@@ -2747,7 +2747,7 @@ The extracted data, either a single row or a list of rows.
27472747
class PostgresLookupField(BasePostgresLookupField)
27482748
```
27492749

2750-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L58)
2750+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L64)
27512751

27522752
<a id="quixstreams.dataframe.joins.lookups.postgresql.PostgresLookupField.build_query"></a>
27532753

@@ -2760,7 +2760,7 @@ def build_query(on: str,
27602760
value: dict[str, Any]) -> Tuple[sql.Composed, Tuple[str, ...]]
27612761
```
27622762

2763-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L97)
2763+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L103)
27642764

27652765
Build the SQL query string for this field.
27662766

@@ -2787,7 +2787,7 @@ A tuple of the SQL query string and the parameters.
27872787
def result(cursor: pg_cursor) -> Union[dict[str, Any], list[dict[str, Any]]]
27882788
```
27892789

2790-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L127)
2790+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L133)
27912791

27922792
Extract the result from the cursor based on the field definition.
27932793

@@ -2812,7 +2812,7 @@ The extracted data, either a single row or a list of rows.
28122812
class PostgresLookupQueryField(BasePostgresLookupField)
28132813
```
28142814

2815-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L142)
2815+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L148)
28162816

28172817
<a id="quixstreams.dataframe.joins.lookups.postgresql.PostgresLookupQueryField.result"></a>
28182818

@@ -2824,7 +2824,7 @@ class PostgresLookupQueryField(BasePostgresLookupField)
28242824
def result(cursor: pg_cursor) -> Union[list[Any], Any]
28252825
```
28262826

2827-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L155)
2827+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L161)
28282828

28292829
Extract the result from the cursor based on the field definition.
28302830

@@ -2849,7 +2849,7 @@ class PostgresLookup(BaseLookup[Union[PostgresLookupField,
28492849
PostgresLookupQueryField]])
28502850
```
28512851

2852-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L168)
2852+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L174)
28532853

28542854
Lookup join implementation for enriching streaming data with data from a Postgres database.
28552855

@@ -2887,7 +2887,7 @@ def __init__(host: str,
28872887
**kwargs)
28882888
```
28892889

2890-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L188)
2890+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L194)
28912891

28922892

28932893
<br>
@@ -2922,7 +2922,7 @@ def field(table: str,
29222922
first_match_only: bool = True) -> PostgresLookupField
29232923
```
29242924

2925-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L312)
2925+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L318)
29262926

29272927
Field definition for use with PostgresLookup in lookup joins.
29282928

@@ -2991,7 +2991,7 @@ def query_field(query: str,
29912991
first_match_only: bool = True) -> PostgresLookupQueryField
29922992
```
29932993

2994-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L386)
2994+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L392)
29952995

29962996
Field definition for use with PostgresLookup in lookup joins.
29972997

@@ -3053,7 +3053,7 @@ def join(fields: Mapping[str, Union[PostgresLookupField,
30533053
Any], key: Any, timestamp: int, headers: Any) -> None
30543054
```
30553055

3056-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L440)
3056+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L446)
30573057

30583058
Enrich the message value in-place by querying SQLite for each field and caching results per TTL.
30593059

@@ -3084,7 +3084,7 @@ None. The input value dictionary is updated in-place with the enriched data.
30843084
def cache_info() -> CacheInfo
30853085
```
30863086

3087-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L480)
3087+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L486)
30883088

30893089
Get cache statistics for the SQLiteLookup LRU cache.
30903090

‎docs/api-reference/quixstreams.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2927,7 +2927,7 @@ timedelta value in milliseconds as `int`
29272927
class BasePostgresLookupField(BaseField, abc.ABC)
29282928
```
29292929

2930-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L25)
2930+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L31)
29312931

29322932
<a id="quixstreams.dataframe.joins.lookups.postgresql.BasePostgresLookupField.build_query"></a>
29332933

@@ -2940,7 +2940,7 @@ def build_query(
29402940
) -> Tuple[sql.Composable, Union[dict[str, Any], Tuple[str, ...]]]
29412941
```
29422942

2943-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L32)
2943+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L38)
29442944

29452945
Build the SQL query string for this field.
29462946

@@ -2962,7 +2962,7 @@ A tuple of the SQL query string and the parameters.
29622962
def result(cursor: pg_cursor) -> Union[dict[str, Any], list[dict[str, Any]]]
29632963
```
29642964

2965-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L46)
2965+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L52)
29662966

29672967
Extract the result from the cursor based on the field definition.
29682968

@@ -2983,7 +2983,7 @@ The extracted data, either a single row or a list of rows.
29832983
class PostgresLookupField(BasePostgresLookupField)
29842984
```
29852985

2986-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L58)
2986+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L64)
29872987

29882988
<a id="quixstreams.dataframe.joins.lookups.postgresql.PostgresLookupField.build_query"></a>
29892989

@@ -2994,7 +2994,7 @@ def build_query(on: str,
29942994
value: dict[str, Any]) -> Tuple[sql.Composed, Tuple[str, ...]]
29952995
```
29962996

2997-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L97)
2997+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L103)
29982998

29992999
Build the SQL query string for this field.
30003000

@@ -3015,7 +3015,7 @@ A tuple of the SQL query string and the parameters.
30153015
def result(cursor: pg_cursor) -> Union[dict[str, Any], list[dict[str, Any]]]
30163016
```
30173017

3018-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L127)
3018+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L133)
30193019

30203020
Extract the result from the cursor based on the field definition.
30213021

@@ -3036,7 +3036,7 @@ The extracted data, either a single row or a list of rows.
30363036
class PostgresLookupQueryField(BasePostgresLookupField)
30373037
```
30383038

3039-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L142)
3039+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L148)
30403040

30413041
<a id="quixstreams.dataframe.joins.lookups.postgresql.PostgresLookupQueryField.result"></a>
30423042

@@ -3046,7 +3046,7 @@ class PostgresLookupQueryField(BasePostgresLookupField)
30463046
def result(cursor: pg_cursor) -> Union[list[Any], Any]
30473047
```
30483048

3049-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L155)
3049+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L161)
30503050

30513051
Extract the result from the cursor based on the field definition.
30523052

@@ -3067,7 +3067,7 @@ class PostgresLookup(BaseLookup[Union[PostgresLookupField,
30673067
PostgresLookupQueryField]])
30683068
```
30693069

3070-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L168)
3070+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L174)
30713071

30723072
Lookup join implementation for enriching streaming data with data from a Postgres database.
30733073

@@ -3103,7 +3103,7 @@ def __init__(host: str,
31033103
**kwargs)
31043104
```
31053105

3106-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L188)
3106+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L194)
31073107

31083108
**Arguments**:
31093109

@@ -3134,7 +3134,7 @@ def field(table: str,
31343134
first_match_only: bool = True) -> PostgresLookupField
31353135
```
31363136

3137-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L312)
3137+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L318)
31383138

31393139
Field definition for use with PostgresLookup in lookup joins.
31403140

@@ -3198,7 +3198,7 @@ def query_field(query: str,
31983198
first_match_only: bool = True) -> PostgresLookupQueryField
31993199
```
32003200

3201-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L386)
3201+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L392)
32023202

32033203
Field definition for use with PostgresLookup in lookup joins.
32043204

@@ -3255,7 +3255,7 @@ def join(fields: Mapping[str, Union[PostgresLookupField,
32553255
Any], key: Any, timestamp: int, headers: Any) -> None
32563256
```
32573257

3258-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L440)
3258+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L446)
32593259

32603260
Enrich the message value in-place by querying SQLite for each field and caching results per TTL.
32613261

@@ -3280,7 +3280,7 @@ None. The input value dictionary is updated in-place with the enriched data.
32803280
def cache_info() -> CacheInfo
32813281
```
32823282

3283-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L480)
3283+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/joins/lookups/postgresql.py#L486)
32843284

32853285
Get cache statistics for the SQLiteLookup LRU cache.
32863286

0 commit comments

Comments
 (0)