Skip to content

CLIENT-4554: updated readme to include canonical example reference #633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BrianNichols merged 1 commit into from
Aug 4, 2026
Merged

CLIENT-4554: updated readme to include canonical example reference #633

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,39 @@ Otherwise, you application's jar will not include any Netty code.
The source code can be imported into your IDE and/or built using Maven.

mvn install

Canonical Reference Application
-------------------------------

[SubMilliPost](https://github.com/aerospike/aerospike-submillipost) is the
canonical reference application for this client library — a stripped-down social
newsletter that teaches Aerospike data modeling through a realistic read-heavy
social graph (users, posts, notes, comments, likes, feeds, notifications, and
more) rather than isolated API samples.

* Repository: https://github.com/aerospike/aerospike-submillipost
* Java source: [`implementations/java`](https://github.com/aerospike/aerospike-submillipost/tree/main/implementations/java)

The programs in `../examples/` show *what* a single API call does. SubMilliPost
shows *when* and *why* to use it — record and bin layout, how operations compose
for a feature, and how client APIs fit real access paths. Aerospike code lives
under `submillipost-api/.../repository/`:

| Operation | Example usage | Where to look |
|---|---|---|
| CRUD | User and post records; conditional create | `UserRepository`, `PostRepository` |
| `operate()` | Atomic likes, counter updates | `ContentLikeRepository` |
| CDTs | Feed lists, nested comment maps | `CommentRepository` |
| Batch reads | Feed hydration across many keys | `AbstractAerospikeRepository` |
| Expressions | Idempotent like guards | `ContentLikeRepository` |
| Queries & TTL | Notification listing, expiration | `NotificationRepository` |

Start with `UserRepository` and `PostRepository`, then follow repositories as
complexity grows. Each feature maps an action to an access path — point read,
list append, atomic update, batch load, or indexed query — so you can see which
client operation fits a given pattern.

Use `examples/` to try an API quickly; use SubMilliPost to learn how those calls
compose in a service. See
[`implementations/java/README.md`](https://github.com/aerospike/aerospike-submillipost/blob/main/implementations/java/README.md)
for build instructions and a full capability map.
Loading