@@ -52,7 +52,8 @@ const (
52
52
type DriverWithContext interface {
53
53
// DefaultExecuteQueryBookmarkManager returns the bookmark manager instance used by ExecuteQuery by default.
54
54
//
55
- // This API is currently experimental and may change or be removed at any time.
55
+ // DefaultExecuteQueryBookmarkManager is part of the BookmarkManager preview feature (see README on what it means in
56
+ // terms of support and compatibility guarantees)
56
57
//
57
58
// This is useful when ExecuteQuery is called without custom bookmark managers and the lower-level
58
59
// neo4j.SessionWithContext APIs are called as well.
@@ -87,7 +88,8 @@ type DriverWithContext interface {
87
88
88
89
// ResultTransformer is a record accumulator that produces an instance of T when the processing of records is over.
89
90
//
90
- // This API is currently experimental and may change or be removed at any time.
91
+ // ResultTransformer is part of the ExecuteQuery preview feature (see README on what it means in terms of support
92
+ // and compatibility guarantees)
91
93
type ResultTransformer [T any ] interface {
92
94
// Accept is called whenever a new record is fetched from the server
93
95
// Implementers are free to accumulate or discard the specified record
@@ -350,7 +352,7 @@ func (d *driverWithContext) Close(ctx context.Context) error {
350
352
// ExecuteQuery runs the specified query with its parameters and returns the query result, transformed by the specified
351
353
// ResultTransformer function.
352
354
//
353
- // This API is currently experimental and may change or be removed at any time.
355
+ // This is currently a preview feature (see README on what it means in terms of support and compatibility guarantees)
354
356
//
355
357
// result, err := ExecuteQuery[*EagerResult](ctx, driver, query, params, EagerResultTransformer)
356
358
//
@@ -545,12 +547,14 @@ func (e *eagerResultTransformer) Complete(keys []string, summary ResultSummary)
545
547
546
548
// ExecuteQueryConfigurationOption is a callback that configures the execution of DriverWithContext.ExecuteQuery
547
549
//
548
- // This API is currently experimental and may change or be removed at any time.
550
+ // ExecuteQueryConfigurationOption is part of the ExecuteQuery preview feature (see README on what it means in terms of
551
+ // support and compatibility guarantees)
549
552
type ExecuteQueryConfigurationOption func (* ExecuteQueryConfiguration )
550
553
551
554
// ExecuteQueryWithReadersRouting configures DriverWithContext.ExecuteQuery to route to reader members of the cluster
552
555
//
553
- // This API is currently experimental and may change or be removed at any time.
556
+ // ExecuteQueryWithReadersRouting is part of the ExecuteQuery preview feature (see README on what it means in terms of
557
+ // support and compatibility guarantees)
554
558
func ExecuteQueryWithReadersRouting () ExecuteQueryConfigurationOption {
555
559
return func (configuration * ExecuteQueryConfiguration ) {
556
560
configuration .Routing = Readers
@@ -559,7 +563,8 @@ func ExecuteQueryWithReadersRouting() ExecuteQueryConfigurationOption {
559
563
560
564
// ExecuteQueryWithWritersRouting configures DriverWithContext.ExecuteQuery to route to writer members of the cluster
561
565
//
562
- // This API is currently experimental and may change or be removed at any time.
566
+ // ExecuteQueryWithWritersRouting is part of the ExecuteQuery preview feature (see README on what it means in terms of
567
+ // support and compatibility guarantees)
563
568
func ExecuteQueryWithWritersRouting () ExecuteQueryConfigurationOption {
564
569
return func (configuration * ExecuteQueryConfiguration ) {
565
570
configuration .Routing = Writers
@@ -568,7 +573,8 @@ func ExecuteQueryWithWritersRouting() ExecuteQueryConfigurationOption {
568
573
569
574
// ExecuteQueryWithImpersonatedUser configures DriverWithContext.ExecuteQuery to impersonate the specified user
570
575
//
571
- // This API is currently experimental and may change or be removed at any time.
576
+ // ExecuteQueryWithImpersonatedUser is part of the ExecuteQuery preview feature (see README on what it means in terms of
577
+ // support and compatibility guarantees)
572
578
func ExecuteQueryWithImpersonatedUser (user string ) ExecuteQueryConfigurationOption {
573
579
return func (configuration * ExecuteQueryConfiguration ) {
574
580
configuration .ImpersonatedUser = user
@@ -577,7 +583,8 @@ func ExecuteQueryWithImpersonatedUser(user string) ExecuteQueryConfigurationOpti
577
583
578
584
// ExecuteQueryWithDatabase configures DriverWithContext.ExecuteQuery to target the specified database
579
585
//
580
- // This API is currently experimental and may change or be removed at any time.
586
+ // ExecuteQueryWithDatabase is part of the ExecuteQuery preview feature (see README on what it means in terms of
587
+ // support and compatibility guarantees)
581
588
func ExecuteQueryWithDatabase (db string ) ExecuteQueryConfigurationOption {
582
589
return func (configuration * ExecuteQueryConfiguration ) {
583
590
configuration .Database = db
@@ -586,7 +593,8 @@ func ExecuteQueryWithDatabase(db string) ExecuteQueryConfigurationOption {
586
593
587
594
// ExecuteQueryWithBookmarkManager configures DriverWithContext.ExecuteQuery to rely on the specified BookmarkManager
588
595
//
589
- // This API is currently experimental and may change or be removed at any time.
596
+ // ExecuteQueryWithBookmarkManager is part of the ExecuteQuery preview feature (see README on what it means in terms of
597
+ // support and compatibility guarantees)
590
598
func ExecuteQueryWithBookmarkManager (bookmarkManager BookmarkManager ) ExecuteQueryConfigurationOption {
591
599
return func (configuration * ExecuteQueryConfiguration ) {
592
600
configuration .BookmarkManager = bookmarkManager
@@ -595,7 +603,8 @@ func ExecuteQueryWithBookmarkManager(bookmarkManager BookmarkManager) ExecuteQue
595
603
596
604
// ExecuteQueryWithoutBookmarkManager configures DriverWithContext.ExecuteQuery to not rely on any BookmarkManager
597
605
//
598
- // This API is currently experimental and may change or be removed at any time.
606
+ // ExecuteQueryWithoutBookmarkManager is part of the ExecuteQuery preview feature (see README on what it means in terms of
607
+ // support and compatibility guarantees)
599
608
func ExecuteQueryWithoutBookmarkManager () ExecuteQueryConfigurationOption {
600
609
return func (configuration * ExecuteQueryConfiguration ) {
601
610
configuration .BookmarkManager = nil
@@ -604,7 +613,8 @@ func ExecuteQueryWithoutBookmarkManager() ExecuteQueryConfigurationOption {
604
613
605
614
// ExecuteQueryWithBoltLogger configures DriverWithContext.ExecuteQuery to log Bolt messages with the provided BoltLogger
606
615
//
607
- // This API is currently experimental and may change or be removed at any time.
616
+ // ExecuteQueryWithBoltLogger is part of the ExecuteQuery preview feature (see README on what it means in terms of
617
+ // support and compatibility guarantees)
608
618
func ExecuteQueryWithBoltLogger (boltLogger log.BoltLogger ) ExecuteQueryConfigurationOption {
609
619
return func (configuration * ExecuteQueryConfiguration ) {
610
620
configuration .BoltLogger = boltLogger
@@ -613,7 +623,8 @@ func ExecuteQueryWithBoltLogger(boltLogger log.BoltLogger) ExecuteQueryConfigura
613
623
614
624
// ExecuteQueryConfiguration holds all the possible configuration settings for DriverWithContext.ExecuteQuery
615
625
//
616
- // This API is currently experimental and may change or be removed at any time.
626
+ // ExecuteQueryConfiguration is part of the ExecuteQuery preview feature (see README on what it means in terms of
627
+ // support and compatibility guarantees)
617
628
type ExecuteQueryConfiguration struct {
618
629
Routing RoutingControl
619
630
ImpersonatedUser string
@@ -624,17 +635,20 @@ type ExecuteQueryConfiguration struct {
624
635
625
636
// RoutingControl specifies how the query executed by DriverWithContext.ExecuteQuery is to be routed
626
637
//
627
- // This API is currently experimental and may change or be removed at any time.
638
+ // RoutingControl is part of the ExecuteQuery preview feature (see README on what it means in terms of support and
639
+ // compatibility guarantees)
628
640
type RoutingControl int
629
641
630
642
const (
631
643
// Writers routes the query to execute to a writer member of the cluster
632
644
//
633
- // This API is currently experimental and may change or be removed at any time.
645
+ // Writers is part of the ExecuteQuery preview feature (see README on what it means in terms of
646
+ // support and compatibility guarantees)
634
647
Writers RoutingControl = iota
635
648
// Readers routes the query to execute to a writer member of the cluster
636
649
//
637
- // This API is currently experimental and may change or be removed at any time.
650
+ // Readers is part of the ExecuteQuery preview feature (see README on what it means in terms of
651
+ // support and compatibility guarantees)
638
652
Readers
639
653
)
640
654
@@ -662,7 +676,8 @@ func (c *ExecuteQueryConfiguration) selectTxFunctionApi(session SessionWithConte
662
676
663
677
// EagerResult holds the result and result metadata of the query executed via DriverWithContext.ExecuteQuery
664
678
//
665
- // This API is currently experimental and may change or be removed at any time.
679
+ // EagerResult is part of the ExecuteQuery preview feature (see README on what it means in terms of
680
+ // support and compatibility guarantees)
666
681
type EagerResult struct {
667
682
Keys []string
668
683
Records []* Record
0 commit comments