Skip to content

Commit

Permalink
Added more package docs (#690)
Browse files Browse the repository at this point in the history
Added more docs
  • Loading branch information
yuce authored Nov 9, 2021
1 parent 61a5260 commit b30be4c
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Requirements:
In your Go module enabled project, add a dependency to `github.com/hazelcast/hazelcast-go-client`:
```shell
# Depend on a specific release
$ go get github.com/hazelcast/hazelcast-go-client@v1.1.0
$ go get github.com/hazelcast/hazelcast-go-client@v1.1.1
```

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

## Documentation

Hazelcast Go Client documentation is hosted at [pkg.go.dev](https://pkg.go.dev/github.com/hazelcast/hazelcast-go-client@v1.1.0).
Hazelcast Go Client documentation is hosted at [pkg.go.dev](https://pkg.go.dev/github.com/hazelcast/hazelcast-go-client@v1.1.1).

You can view the documentation locally by using godoc:
```
Expand Down
2 changes: 2 additions & 0 deletions aggregate/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,7 @@

/*
Package aggregate provides aggregation functions.
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.
*/
package aggregate
18 changes: 18 additions & 0 deletions hzerrors/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/*
* Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// Package hzerrors provides sentinel errors.
package hzerrors
1 change: 1 addition & 0 deletions logger/logger_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
* limitations under the License.
*/

// Package logger contains logger configuration.
package logger

import (
Expand Down
28 changes: 28 additions & 0 deletions predicate/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License")
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/*
Package predicate provides built-in predicates to use with distributed queries.
How Distributed Query Works
1. The requested predicate is sent to each member in the cluster.
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.
3. The predicate requester merges all the results coming from each member into a single set.
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.
*/
package predicate

0 comments on commit b30be4c

Please sign in to comment.