feat(examples): add p/jeronimoalbi/datastore package

[jeronimoalbi]

The purpose of this package is to support a data store where multiple collection based storages could be defined.

Each named storage defines a collection of records where each record can optionally and by default have any number of user defined fields, which can be constrained to a pre defined set of fields by using a schema definition.

The implementation is a layer on top of p/moul/collection.

Example of datastore package usage:

package main

import (
	ds "gno.land/p/jeronimoalbi/datastore"
)

func main() {
	var db ds.Datastore

	// Define a unique case insensitive index for user emails
	emailIdx := ds.NewIndex("email", func(r ds.Record) string {
		return r.MustGet("email").(string)
	}).Unique().CaseInsensitive()

	// Create a new storage for user records
	storage := db.CreateStorage("users", ds.WithIndex(emailIdx))

	// Add a user with a single "email" field
	u := storage.NewRecord()
	u.Set("email", "[email protected]")

	// Save to assing user ID and update index(es)
	u.Save()
	println("Records =", storage.Size())

	// Find the user by email
	print("Search by Email ... ")
	record, found := storage.Get(emailIdx.Name(), "[email protected]")
	if !found {
		panic("record by email not found")
	}

	println("ID =", record.ID())

	// Find user by ID
	print("Search by ID ... ")
	record, found = storage.GetByID(u.ID())
	if !found {
		panic("record by ID not found")
	}

	email := record.MustGet("email").(string)
	println("Email =", email)

	// Delete the user from the storage and update index(es)
	storage.Delete(u.ID())
	println("Records =", storage.Size())
}

// Output:
// Records = 1
// Search by Email ... ID = 1
// Search by ID ... Email = [email protected]
// Records = 0

[Gno2D2]

🛠 PR Checks Summary

🔴 Pending initial approval by a review team member, or review from tech-staff

Manual Checks (for Reviewers):

• IGNORE the bot requirements for this PR (force green CI check)

Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🔴 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:

1. Fix any issues flagged by automated checks.
2. Follow the Contributor Checklist to ensure your PR is ready for review.
   • Add new tests, or document why they are unnecessary.
   • Provide clear examples/screenshots, if necessary.
   • Update documentation, if required.
   • Ensure no breaking changes, or include BREAKING CHANGE notes.
   • Link related issues/PRs, where applicable.

☑️ Reviewer Actions:

1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.

📚 Resources:

• Report a bug with the bot.
• View the bot’s configuration file.

Debug

Automated Checks

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🔴 Requirement not satisfied
└── 🔴 If
    ├── 🔴 Condition
    │   └── 🔴 Or
    │       ├── 🔴 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🔴 Else
        └── 🔴 And
            ├── 🟢 This label is applied to pull request: review/triage-pending
            └── 🔴 On no pull request

Manual Checks

**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

• Any user with comment edit permission

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[jeronimoalbi]

Moving back to draft to rethink data iteration

[jeronimoalbi]

Iteration can be done by using a query to get a recordset:

package main

import (
	ds "gno.land/p/jeronimoalbi/datastore"
)

func main() {
	var db ds.Datastore

	// Create a new storage for user records
	storage := db.CreateStorage("users")

	// Add a couple of empty records
	storage.NewRecord().Save() // ID 1
	storage.NewRecord().Save() // ID 2
	storage.NewRecord().Save() // ID 3
	storage.NewRecord().Save() // ID 4

	// Query records with a custom offset and size
	recordset, err := storage.Query(ds.WithOffset(1), ds.WithSize(2))
	if err != nil {
		panic(err)
	}

	// Get all query results
	recordset.Iterate(func(r ds.Record) bool {
		println("ID = ", r.ID())
		return false
	})
}

// Output:
// ID = 2
// ID = 3

By default query uses an ID index that contains all available storage records, but it supports a UseIndex(indexName, indexKey string) option to get records that match with a custom index key.