@@ -446,36 +446,28 @@ This method searches for rows that satisfy the search condition and updates them
446
446
- response ` success ` is ` True `
447
447
- failure: ` Exception `
448
448
449
- # table_obj.query_builder
450
449
451
- Gets a query_builder by self.
452
-
453
- ``` python
454
- query_builder= table_obj.query_builder
455
- ```
456
-
457
- ## Details
458
-
459
- This method retrieves a query_builder by self table.
460
-
461
- ## Returns
462
-
463
- - success:
464
- - A ` query_builder ` object.
465
- - failure: ` Exception `
466
-
467
- ---
468
-
469
- # query_builder.output
450
+ # table_obj.output
470
451
471
452
Specifies the columns to display in the search output.
472
453
473
454
``` python
474
- query_builder .output([" num" , " body" ])
455
+ table_obj .output([" num" , " body" ])
475
456
# To display all columns
476
- query_builder .output([" *" ])
457
+ table_obj .output([" *" ])
477
458
# To display row ID
478
- query_builder.output([" _row_id" ])
459
+ table_obj.output([" _row_id" ])
460
+ ```
461
+ Convert output to different display types.
462
+ ``` python
463
+ # Returns a data result
464
+ table_obj.output([" *" ]).to_result()
465
+ # Returns a pandas result
466
+ table_obj.output([" *" ]).to_df()
467
+ # Returns a polars result
468
+ table_obj.output([" *" ]).to_pl()
469
+ # Returns a pyarrow result
470
+ table_obj.output([" *" ]).to_arrow()
479
471
```
480
472
481
473
## Details
@@ -493,12 +485,12 @@ This method specifies the columns to display in the search output. You must inpu
493
485
494
486
- self : ` InfinityThriftQueryBuilder `
495
487
496
- # query_builder .filter
488
+ # table_obj .filter
497
489
498
490
Builds a filtering condition expression.
499
491
500
492
``` python
501
- query_builder .filter(" (-7 < c1 or 9 >= c1) and (c2 = 3)" )
493
+ table_obj .filter(" (-7 < c1 or 9 >= c1) and (c2 = 3)" )
502
494
```
503
495
504
496
## Details
@@ -515,13 +507,13 @@ This method builds a filtering expression.
515
507
516
508
- self : ` InfinityThriftQueryBuilder `
517
509
518
- # query_builder .knn
510
+ # table_obj .knn
519
511
520
512
Builds a KNN search expression.
521
513
522
514
``` python
523
- query_builder .knn(' col1' , [0.1 ,0.2 ,0.3 ], ' float' , ' l2' , 100 )
524
- query_builder .knn(' vec' , [3.0 ] * 5 , ' float' , ' ip' , 2 )
515
+ table_obj .knn(' col1' , [0.1 ,0.2 ,0.3 ], ' float' , ' l2' , 100 )
516
+ table_obj .knn(' vec' , [3.0 ] * 5 , ' float' , ' ip' , 2 )
525
517
```
526
518
527
519
## Details
@@ -548,12 +540,12 @@ VEC supports list or np.ndarray.
548
540
549
541
- self : ` InfinityThriftQueryBuilder `
550
542
551
- # query_builder .match
543
+ # table_obj .match
552
544
553
545
Builds a full-text search expression.
554
546
555
547
``` python
556
- query_builder .match(' body' , ' harmful' , ' topn=2' )
548
+ table_obj .match(' body' , ' harmful' , ' topn=2' )
557
549
```
558
550
559
551
## Details
@@ -570,12 +562,12 @@ This method builds a full-text search expression.
570
562
571
563
- self : ` InfinityThriftQueryBuilder `
572
564
573
- # query_builder .fusion
565
+ # table_obj .fusion
574
566
575
567
Builds a fusion expression.
576
568
577
569
``` python
578
- query_builder .fusion(' rrf' )
570
+ table_obj .fusion(' rrf' )
579
571
```
580
572
581
573
## Details
@@ -592,12 +584,12 @@ query_builder.fusion('rrf')
592
584
593
585
- self : ` InfinityThriftQueryBuilder `
594
586
595
- # query_builder .to_result
587
+ # table_obj.output .to_result
596
588
597
589
Returns a data result.
598
590
599
591
``` python
600
- table_obj.query_builder(). output([" *" ]).to_result()
592
+ table_obj.output([" *" ]).to_result()
601
593
```
602
594
603
595
## Details
@@ -610,12 +602,12 @@ This method returns a data result of Python's built-in type.
610
602
611
603
- ` tuple[dict[str, list[Any]], dict[str, Any]] `
612
604
613
- # query_builder .to_df
605
+ # table_obj.output .to_df
614
606
615
607
Returns a pandas result.
616
608
617
609
``` python
618
- table_obj.query_builder(). output([" *" ]).to_df()
610
+ table_obj.output([" *" ]).to_df()
619
611
```
620
612
621
613
## Details
@@ -626,12 +618,12 @@ This method returns a data result in pandas `DataFrame`.
626
618
627
619
- ` pandas.DataFrame `
628
620
629
- # query_builder .to_pl
621
+ # table_obj.output .to_pl
630
622
631
623
Returns a polars result.
632
624
633
625
``` python
634
- table_obj.query_builder(). output([" *" ]).to_pl()
626
+ table_obj.output([" *" ]).to_pl()
635
627
```
636
628
637
629
## Details
@@ -642,12 +634,12 @@ This method returns a data result in polars `DataFrame`
642
634
643
635
- ` polars.DataFrame `
644
636
645
- # query_builder .to_arrow
637
+ # table_obj.output .to_arrow
646
638
647
639
Returns a pyarrow result.
648
640
649
641
``` python
650
- table_obj.query_builder(). output([" *" ]).to_arrow()
642
+ table_obj.output([" *" ]).to_arrow()
651
643
```
652
644
653
645
## Details
0 commit comments