@@ -1422,7 +1422,7 @@ <h1 id="query">Query<a class="headerlink" href="#query" title="Permanent link">#
1422
1422
Users will never construct a Query object using the constructor of the class.
1423
1423
For this reason we do not provide the full documentation of the class here.</ p >
1424
1424
< h2 id ="methods "> Methods< a class ="headerlink " href ="#methods " title ="Permanent link "> #</ a > </ h2 >
1425
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L543 "> [source]</ a > </ span > </ p >
1425
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L550 "> [source]</ a > </ span > </ p >
1426
1426
< h3 id ="append_feature "> append_feature< a class ="headerlink " href ="#append_feature " title ="Permanent link "> #</ a > </ h3 >
1427
1427
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> append_feature</ span > < span class ="p "> (</ span > < span class ="n "> feature</ span > < span class ="p "> )</ span >
1428
1428
</ code > </ pre > </ div >
@@ -1432,7 +1432,7 @@ <h3 id="append_feature">append_feature<a class="headerlink" href="#append_featur
1432
1432
< li > < strong > feature</ strong > : < code > [str, Feature]</ code > . Name of the feature to append to the query.</ li >
1433
1433
</ ul >
1434
1434
< hr />
1435
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L245 "> [source]</ a > </ span > </ p >
1435
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L252 "> [source]</ a > </ span > </ p >
1436
1436
< h3 id ="as_of "> as_of< a class ="headerlink " href ="#as_of " title ="Permanent link "> #</ a > </ h3 >
1437
1437
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> as_of</ span > < span class ="p "> (</ span > < span class ="n "> wallclock_time</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> exclude_until</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> )</ span >
1438
1438
</ code > </ pre > </ div >
@@ -1507,7 +1507,7 @@ <h3 id="as_of">as_of<a class="headerlink" href="#as_of" title="Permanent link">#
1507
1507
< p > < strong > Returns</ strong > </ p >
1508
1508
< p > < code > Query</ code > . The query object with the applied time travel condition.</ p >
1509
1509
< hr />
1510
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L351 "> [source]</ a > </ span > </ p >
1510
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L358 "> [source]</ a > </ span > </ p >
1511
1511
< h3 id ="filter "> filter< a class ="headerlink " href ="#filter " title ="Permanent link "> #</ a > </ h3 >
1512
1512
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> filter</ span > < span class ="p "> (</ span > < span class ="n "> f</ span > < span class ="p "> )</ span >
1513
1513
</ code > </ pre > </ div >
@@ -1560,12 +1560,12 @@ <h3 id="filter">filter<a class="headerlink" href="#filter" title="Permanent link
1560
1560
< p > < strong > Returns</ strong > </ p >
1561
1561
< p > < code > Query</ code > . The query object with the applied filter.</ p >
1562
1562
< hr />
1563
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L437 "> [source]</ a > </ span > </ p >
1563
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L444 "> [source]</ a > </ span > </ p >
1564
1564
< h3 id ="from_response_json "> from_response_json< a class ="headerlink " href ="#from_response_json " title ="Permanent link "> #</ a > </ h3 >
1565
1565
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> from_response_json</ span > < span class ="p "> (</ span > < span class ="n "> json_dict</ span > < span class ="p "> )</ span >
1566
1566
</ code > </ pre > </ div >
1567
1567
< hr />
1568
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L687 "> [source]</ a > </ span > </ p >
1568
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L694 "> [source]</ a > </ span > </ p >
1569
1569
< h3 id ="get_feature "> get_feature< a class ="headerlink " href ="#get_feature " title ="Permanent link "> #</ a > </ h3 >
1570
1570
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> get_feature</ span > < span class ="p "> (</ span > < span class ="n "> feature_name</ span > < span class ="p "> )</ span >
1571
1571
</ code > </ pre > </ div >
@@ -1577,19 +1577,19 @@ <h3 id="get_feature">get_feature<a class="headerlink" href="#get_feature" title=
1577
1577
< p > < strong > Returns</ strong > </ p >
1578
1578
< p > < code > Feature</ code > . Feature object.</ p >
1579
1579
< hr />
1580
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L564 "> [source]</ a > </ span > </ p >
1580
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L571 "> [source]</ a > </ span > </ p >
1581
1581
< h3 id ="is_cache_feature_group_only "> is_cache_feature_group_only< a class ="headerlink " href ="#is_cache_feature_group_only " title ="Permanent link "> #</ a > </ h3 >
1582
1582
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> is_cache_feature_group_only</ span > < span class ="p "> ()</ span >
1583
1583
</ code > </ pre > </ div >
1584
1584
< p > Query contains only cached feature groups</ p >
1585
1585
< hr />
1586
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L556 "> [source]</ a > </ span > </ p >
1586
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L563 "> [source]</ a > </ span > </ p >
1587
1587
< h3 id ="is_time_travel "> is_time_travel< a class ="headerlink " href ="#is_time_travel " title ="Permanent link "> #</ a > </ h3 >
1588
1588
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> is_time_travel</ span > < span class ="p "> ()</ span >
1589
1589
</ code > </ pre > </ div >
1590
1590
< p > Query contains time travel</ p >
1591
1591
< hr />
1592
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L189 "> [source]</ a > </ span > </ p >
1592
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L196 "> [source]</ a > </ span > </ p >
1593
1593
< h3 id ="join "> join< a class ="headerlink " href ="#join " title ="Permanent link "> #</ a > </ h3 >
1594
1594
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> join</ span > < span class ="p "> (</ span > < span class ="n "> sub_query</ span > < span class ="p "> ,</ span > < span class ="n "> on</ span > < span class ="o "> =</ span > < span class ="p "> [],</ span > < span class ="n "> left_on</ span > < span class ="o "> =</ span > < span class ="p "> [],</ span > < span class ="n "> right_on</ span > < span class ="o "> =</ span > < span class ="p "> [],</ span > < span class ="n "> join_type</ span > < span class ="o "> =</ span > < span class ="s2 "> "inner"</ span > < span class ="p "> ,</ span > < span class ="n "> prefix</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> )</ span >
1595
1595
</ code > </ pre > </ div >
@@ -1633,7 +1633,7 @@ <h3 id="join">join<a class="headerlink" href="#join" title="Permanent link">#</a
1633
1633
< p > < strong > Returns</ strong > </ p >
1634
1634
< p > < code > Query</ code > : A new Query object representing the join.</ p >
1635
1635
< hr />
1636
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L337 "> [source]</ a > </ span > </ p >
1636
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L344 "> [source]</ a > </ span > </ p >
1637
1637
< h3 id ="pull_changes "> pull_changes< a class ="headerlink " href ="#pull_changes " title ="Permanent link "> #</ a > </ h3 >
1638
1638
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> pull_changes</ span > < span class ="p "> (</ span > < span class ="n "> wallclock_start_time</ span > < span class ="p "> ,</ span > < span class ="n "> wallclock_end_time</ span > < span class ="p "> )</ span >
1639
1639
</ code > </ pre > </ div >
@@ -1643,7 +1643,7 @@ <h3 id="pull_changes">pull_changes<a class="headerlink" href="#pull_changes" tit
1643
1643
< p > < code > pull_changes</ code > method is deprecated. Use
1644
1644
`as_of(end_wallclock_time, exclude_until=start_wallclock_time) instead.</ p >
1645
1645
< hr />
1646
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L104 "> [source]</ a > </ span > </ p >
1646
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L111 "> [source]</ a > </ span > </ p >
1647
1647
< h3 id ="read "> read< a class ="headerlink " href ="#read " title ="Permanent link "> #</ a > </ h3 >
1648
1648
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> read</ span > < span class ="p "> (</ span > < span class ="n "> online</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span > < span class ="n "> dataframe_type</ span > < span class ="o "> =</ span > < span class ="s2 "> "default"</ span > < span class ="p "> ,</ span > < span class ="n "> read_options</ span > < span class ="o "> =</ span > < span class ="p "> {})</ span >
1649
1649
</ code > </ pre > </ div >
@@ -1677,7 +1677,7 @@ <h3 id="read">read<a class="headerlink" href="#read" title="Permanent link">#</a
1677
1677
< p > < strong > Returns</ strong > </ p >
1678
1678
< p > < code > DataFrame</ code > : DataFrame depending on the chosen type.</ p >
1679
1679
< hr />
1680
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L165 "> [source]</ a > </ span > </ p >
1680
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L172 "> [source]</ a > </ span > </ p >
1681
1681
< h3 id ="show "> show< a class ="headerlink " href ="#show " title ="Permanent link "> #</ a > </ h3 >
1682
1682
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> show</ span > < span class ="p "> (</ span > < span class ="n "> n</ span > < span class ="p "> ,</ span > < span class ="n "> online</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> )</ span >
1683
1683
</ code > </ pre > </ div >
@@ -1698,7 +1698,7 @@ <h3 id="show">show<a class="headerlink" href="#show" title="Permanent link">#</a
1698
1698
< li > < strong > online</ strong > < code > Optional[bool]</ code > : Show from online storage. Defaults to < code > False</ code > .</ li >
1699
1699
</ ul >
1700
1700
< hr />
1701
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L496 "> [source]</ a > </ span > </ p >
1701
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L503 "> [source]</ a > </ span > </ p >
1702
1702
< h3 id ="to_string "> to_string< a class ="headerlink " href ="#to_string " title ="Permanent link "> #</ a > </ h3 >
1703
1703
< div class ="highlight "> < pre > < span > </ span > < code > < span class ="n "> Query</ span > < span class ="o "> .</ span > < span class ="n "> to_string</ span > < span class ="p "> (</ span > < span class ="n "> online</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span > < span class ="n "> arrow_flight</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> )</ span >
1704
1704
</ code > </ pre > </ div >
@@ -1714,27 +1714,27 @@ <h3 id="to_string">to_string<a class="headerlink" href="#to_string" title="Perma
1714
1714
</ div >
1715
1715
< hr />
1716
1716
< h2 id ="properties "> Properties< a class ="headerlink " href ="#properties " title ="Permanent link "> #</ a > </ h2 >
1717
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L654 "> [source]</ a > </ span > </ p >
1717
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L661 "> [source]</ a > </ span > </ p >
1718
1718
< h3 id ="featuregroups "> featuregroups< a class ="headerlink " href ="#featuregroups " title ="Permanent link "> #</ a > </ h3 >
1719
1719
< p > List of feature groups used in the query</ p >
1720
1720
< hr />
1721
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L674 "> [source]</ a > </ span > </ p >
1721
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L681 "> [source]</ a > </ span > </ p >
1722
1722
< h3 id ="features "> features< a class ="headerlink " href ="#features " title ="Permanent link "> #</ a > </ h3 >
1723
1723
< p > List of all features in the query</ p >
1724
1724
< hr />
1725
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L662 "> [source]</ a > </ span > </ p >
1725
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L669 "> [source]</ a > </ span > </ p >
1726
1726
< h3 id ="filters "> filters< a class ="headerlink " href ="#filters " title ="Permanent link "> #</ a > </ h3 >
1727
1727
< p > All filters used in the query</ p >
1728
1728
< hr />
1729
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L649 "> [source]</ a > </ span > </ p >
1729
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L656 "> [source]</ a > </ span > </ p >
1730
1730
< h3 id ="joins "> joins< a class ="headerlink " href ="#joins " title ="Permanent link "> #</ a > </ h3 >
1731
1731
< p > List of joins in the query</ p >
1732
1732
< hr />
1733
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L530 "> [source]</ a > </ span > </ p >
1733
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L537 "> [source]</ a > </ span > </ p >
1734
1734
< h3 id ="left_feature_group_end_time "> left_feature_group_end_time< a class ="headerlink " href ="#left_feature_group_end_time " title ="Permanent link "> #</ a > </ h3 >
1735
1735
< p > End time of time travel for the left feature group.</ p >
1736
1736
< hr />
1737
- < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L525 "> [source]</ a > </ span > </ p >
1737
+ < p > < span style ="float:right; "> < a href ="https://github.com/logicalclocks/feature-store-api/blob/master/python/hsfs/constructor/query.py#L532 "> [source]</ a > </ span > </ p >
1738
1738
< h3 id ="left_feature_group_start_time "> left_feature_group_start_time< a class ="headerlink " href ="#left_feature_group_start_time " title ="Permanent link "> #</ a > </ h3 >
1739
1739
< p > Start time of time travel for the left feature group.</ p >
1740
1740
< hr />
0 commit comments