Examples

examples/README.md

@@ -0,0 +1,21 @@
+# How it could work
+
+## Given
+
+* A CoreDB cluster is deployed
+* I have user credentials to deploy to it
+* I have created a coredb project on my machine via `coredb init` command
+* I create files according to coredb docs
+
+## When
+
+* I type `coredb deploy`
+
+## Then
+
+* My files are analyzed and good stuff happens in the CoreDB cluster
+  * `db/schemas` directory is parsed for changes, and migrations are generated
+    * potentially problematic migrations are flagged
+    * the cli steps me through the migrations one-by-one
+  * `instances` directory is parsed for instances of postgres to spin up, within which dataplane clusters, and with what limitations (this assumes that we have magic multi-master functionality, which doesn't exist yet)
+  * `apps` directory is parsed for apps to bundle into the postgres deployment (initially, only `actix` framework)

examples/db/schemas/posts.toml

@@ -0,0 +1,26 @@
+[table]
+schema = "main"
+name = "posts"
+
+[table.fields.id]
+type = "int"
+default = "autoincrement()"
+
+[table.fields.createdAt]
+type = "DateTime"
+default = "now()"
+
+[table.fields.updatedAt]
+type = "DateTime"
+
+[table.fields.title]
+type = "VARCHAR(200)"
+default = ""
+
+[table.fields.body]
+type = "VARCHAR"
+default = ""
+
+[table.fields.slug]
+type = "VARCHAR(255)"
+unique = true

examples/instances/primary.toml

@@ -0,0 +1,9 @@
+[instance]
+name = "primary"
+cpu = "2"
+mem = "4096"
+coredb_account_cluster = "google-us-west"
+
+[tables]
+include = ["posts"]
+

examples/instances/read.toml

@@ -0,0 +1,10 @@
+[instance]
+name = "read"
+cpu = "1"
+mem = "1024"
+read_only = true
+coredb_account_cluster = "aws-us-east"
+
+[tables]
+include = ["posts"]
+