Skip to content

Commit

Permalink
chore(docs): added MapR on docs (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
cnlangzi authored Mar 11, 2024
1 parent 2655db2 commit 8f3ce63
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 2 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Tests

concurrency:
group: "tests-${{ github.ref }}"
cancel-in-progress: true

on:
push:
branches:
- main
- dev
tags:
pull_request:
workflow_dispatch:

jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Clone
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ^1.21
- name: golangci-lint
uses: golangci/golangci-lint-action@v3
with:
version: v1.54
unit-tests:
name: Unit Tests
runs-on: ubuntu-latest
steps:
- name: Clone
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: ^1.21
- name: Unit Tests
run: |
make unit-tests
- name: Codecov
uses: codecov/codecov-action@v4
with:
files: ./coverage.txt
flags: Unit-Tests
verbose: true
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.2.2]
### Added
## [1.3.0]
### Added
- added `Query[T]` feature and `MapR[T]` Queryer for cross-databases query (#21)

## [1.2.2] - 2024-03-05
### Added
- added detail logs on migration (#17)
- added rotated table migration support (#17)
- added `Rotate` method for rotate service (#18)
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ You’ll find the SQLE package useful if you’re not a fan of full-featured ORM
- [ShardID](shardid/README.md) is a `snowflakes-like` distributed unique identifier with extended metadata : worker, table rotation and database sharding, and sortable by time
- Table AutoRotation
- Database AutoSharding
- MapR Query
- [Migration](migrate/migrator_test.go): migrate database with sql files organized in filesystem. it supports to migrate table and multiple rotated tables on all sharding database instances.

## Tutorials
Expand Down Expand Up @@ -465,6 +466,9 @@ db.On(id). //automatically select database based on `id.DatabaseID`

see more [examples](db_test.go#L49)

## MapR Query
SQLE uses `MapR[T]` queryer to connect and retrieve data from rotated tables and sharding databases. see more [examples](./queryer_mapr_test.go)

## Migration
SQLE discovers migrations from local file system or go embed file system. There are two objects here.
- version directory
Expand Down

0 comments on commit 8f3ce63

Please sign in to comment.