Skip to content

Commit 5ade768

Browse files
chore: add godocs
1 parent 62e215a commit 5ade768

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

finder/split.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ func WrapSplitIndex(
6666
}
6767
}
6868

69+
// Execute will try to split query if it contains list in it. If query can't be split wrapped Finder will be used.
70+
// Use List, Series or Bytes after calling Execute to get data.
6971
func (splitFinder *SplitIndexFinder) Execute(
7072
ctx context.Context,
7173
config *config.Config,
@@ -274,6 +276,8 @@ func (splitFinder *SplitIndexFinder) whereFilter(queries []string, from, until i
274276
return aggregatedWhere, nil
275277
}
276278

279+
// List returns clickhouse response split by delimiter.
280+
// If there was no split, wrapped.List will be used.
277281
func (splitFinder *SplitIndexFinder) List() [][]byte {
278282
if splitFinder.useWrapped {
279283
return splitFinder.wrapped.List()
@@ -282,6 +286,7 @@ func (splitFinder *SplitIndexFinder) List() [][]byte {
282286
return makeList(splitFinder.rows, false)
283287
}
284288

289+
// Series same as List. If there was no split, wrapped.Series will be used.
285290
func (splitFinder *SplitIndexFinder) Series() [][]byte {
286291
if splitFinder.useWrapped {
287292
return splitFinder.wrapped.Series()
@@ -290,6 +295,8 @@ func (splitFinder *SplitIndexFinder) Series() [][]byte {
290295
return makeList(splitFinder.rows, true)
291296
}
292297

298+
// Abs for this implementation returns given v.
299+
// If there was no split, wrapped.Abs will be used.
293300
func (splitFinder *SplitIndexFinder) Abs(v []byte) []byte {
294301
if splitFinder.useWrapped {
295302
return splitFinder.wrapped.Abs(v)
@@ -298,6 +305,8 @@ func (splitFinder *SplitIndexFinder) Abs(v []byte) []byte {
298305
return v
299306
}
300307

308+
// Bytes returns clickhouse response bytes.
309+
// If there was no split, wrapped.Bytes will be used.
301310
func (splitFinder *SplitIndexFinder) Bytes() ([]byte, error) {
302311
if splitFinder.useWrapped {
303312
return splitFinder.wrapped.Bytes()

0 commit comments

Comments
 (0)