Skip to content

Commit b30be4c

Browse files
authored
Added more package docs (#690)
Added more docs
1 parent 61a5260 commit b30be4c

File tree

5 files changed

+51
-2
lines changed

5 files changed

+51
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Requirements:
6767
In your Go module enabled project, add a dependency to `github.com/hazelcast/hazelcast-go-client`:
6868
```shell
6969
# Depend on a specific release
70-
$ go get github.com/hazelcast/[email protected].0
70+
$ go get github.com/hazelcast/[email protected].1
7171
```
7272

7373
## Quick Start
@@ -119,7 +119,7 @@ client, err := hazelcast.StartNewClientWithConfig(ctx, config)
119119

120120
## Documentation
121121

122-
Hazelcast Go Client documentation is hosted at [pkg.go.dev](https://pkg.go.dev/github.com/hazelcast/[email protected].0).
122+
Hazelcast Go Client documentation is hosted at [pkg.go.dev](https://pkg.go.dev/github.com/hazelcast/[email protected].1).
123123

124124
You can view the documentation locally by using godoc:
125125
```

aggregate/doc.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,7 @@
1616

1717
/*
1818
Package aggregate provides aggregation functions.
19+
20+
Aggregations allow computing a value of some function (e.g Sum or Max) over the stored map entries. The computation is performed in a fully distributed manner, so no data other than the computed function value is transferred to the client, making the computation fast.
1921
*/
2022
package aggregate

hzerrors/doc.go

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/*
2+
* Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License")
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
// Package hzerrors provides sentinel errors.
18+
package hzerrors

logger/logger_config.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17+
// Package logger contains logger configuration.
1718
package logger
1819

1920
import (

predicate/doc.go

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License")
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
/*
18+
Package predicate provides built-in predicates to use with distributed queries.
19+
20+
How Distributed Query Works
21+
22+
1. The requested predicate is sent to each member in the cluster.
23+
2. Each member looks at its own local entries and filters them according to the predicate. At this stage, key-value pairs of the entries are deserialized and then passed to the predicate.
24+
3. The predicate requester merges all the results coming from each member into a single set.
25+
26+
Distributed query is highly scalable. If you add new members to the cluster, the partition count for each member is reduced and thus the time spent by each member on iterating its entries is reduced. In addition, the pool of partition threads evaluates the entries concurrently in each member, and the network traffic is also reduced since only filtered data is sent to the requester.
27+
*/
28+
package predicate

0 commit comments

Comments
 (0)