https://github.com/jonico/matrix-demos
Self-served demos showing non-blocking schema changes in action while writing with Gigabytes of data with thousands of parallel connections
https://github.com/jonico/matrix-demos
Last synced: 29 days ago
JSON representation
Self-served demos showing non-blocking schema changes in action while writing with Gigabytes of data with thousands of parallel connections
- Host: GitHub
- URL: https://github.com/jonico/matrix-demos
- Owner: jonico
- Created: 2022-01-24T09:38:17.000Z (over 4 years ago)
- Default Branch: ps
- Last Pushed: 2022-01-27T16:45:45.000Z (over 4 years ago)
- Last Synced: 2025-03-03T16:14:56.580Z (over 1 year ago)
- Language: Shell
- Homepage: https://youtu.be/paIBD4LNHqw
- Size: 6.02 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# matrix-demos
Demos to show PlanetScale DB capabilities with a common matrix topic / visualization. All demos are browser based - either using Codespaces or GitHub Actions and should run out of the box. The Action based demos also work with the free community tier as long as you are not using crazy dimensions for the matrices.
## Demos included so far
### Codespace based examples
* [Demo how many parallel connections we support](codespace-based-demos.md#how-to-use-parallel-connection-test-demo)

* [Demo how non-blocking schema changes work](codespace-based-demos.md#how-to-use-non-blocking-schema-change-demo)

### Action based examples
The [Action based demos](action-based-demos.md) do not need Codespaces but offer a similar functionality (with a slightly longer startup time).
If you click on the Actions tab of your repo, you will see the suggested workflows to run starting from 01.

## Before you start exploring
### A Sign up for a PlanetScale account
If you have not done already, [sign up here](https://auth.planetscale.com/sign-up) for a PlanetScale account, you can have one database for free. Do not create a database yet though, this step will be automated as part of the demos.
### B Create your own copy of this repository template
If somebody from your team has already configured the demos in a copy of the original repository and you like to share - this is fine. In order to run a CodeSpace you would need membership write write acces to the repository. Otherwise, just create a copy of this repository template by clicking on the green 'Use this template' button. Both private as well as public repo visibility will work.

### C Decide whether you like to use GitHub Codespaces or GitHub Actions for the demo
GitHub CodeSpaces will provide faster performance and the ability to use the same repo for multiple people, but you need to sign up (and probably pay) for CodeSpace usage. When you decide to use the GitHub Actions based demo flow instead, demo startup will take a little longer. On the other hand, GitHub provides GitHub Action minutes for free for public repositories and also provides a generous amount of free Action minutes for private repositories.
It is ultimately your choice - and also possible to run the demos with both CodeSpaces and Actions.
If you decide for Actions, [follow this document](action-based-demos.md), for Codespaces - continue [here](codespace-based-demos.md).