kolumn 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +78 -0
- package/index.js +36 -0
- package/package.json +31 -0
package/README.md
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# Kolumn
|
|
2
|
+
|
|
3
|
+
**Infrastructure as Code for Database Schema Management**
|
|
4
|
+
|
|
5
|
+
> **Note:** The Kolumn CLI is written in Go. This npm package is a placeholder to reserve the package name and direct users to the correct installation method.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
Kolumn CLI is available via:
|
|
10
|
+
|
|
11
|
+
### Homebrew (macOS/Linux)
|
|
12
|
+
```bash
|
|
13
|
+
brew install schemabounce/tap/kolumn
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
### Direct Download
|
|
17
|
+
Download from [GitHub Releases](https://github.com/SchemaBounce/Kolumn-deploy/releases)
|
|
18
|
+
|
|
19
|
+
### Docker
|
|
20
|
+
```bash
|
|
21
|
+
docker pull schemabounce/kolumn
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## What is Kolumn?
|
|
25
|
+
|
|
26
|
+
Kolumn is an Infrastructure as Code (IaC) tool for managing database schemas. Think of it as "Terraform for databases."
|
|
27
|
+
|
|
28
|
+
### Key Features
|
|
29
|
+
|
|
30
|
+
- **Declarative Schema Management** - Define your database schema in HCL
|
|
31
|
+
- **Multi-Provider Support** - PostgreSQL, MySQL, Snowflake, BigQuery, and more
|
|
32
|
+
- **Drift Detection** - Detect unmanaged changes to your database
|
|
33
|
+
- **Safe Migrations** - Preview changes before applying them
|
|
34
|
+
- **State Management** - Track schema state across environments
|
|
35
|
+
|
|
36
|
+
### Example
|
|
37
|
+
|
|
38
|
+
```hcl
|
|
39
|
+
provider "postgres" {
|
|
40
|
+
host = "localhost"
|
|
41
|
+
port = 5432
|
|
42
|
+
database = "production"
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
create "postgres_table" "users" {
|
|
46
|
+
schema = "public"
|
|
47
|
+
name = "users"
|
|
48
|
+
|
|
49
|
+
columns = {
|
|
50
|
+
id = {
|
|
51
|
+
type = "BIGSERIAL"
|
|
52
|
+
primary_key = true
|
|
53
|
+
}
|
|
54
|
+
email = {
|
|
55
|
+
type = "VARCHAR(255)"
|
|
56
|
+
not_null = true
|
|
57
|
+
unique = true
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Documentation
|
|
64
|
+
|
|
65
|
+
- [Getting Started](https://schemabounce.com/kolumn/docs/getting-started)
|
|
66
|
+
- [CLI Reference](https://schemabounce.com/kolumn/docs/cli)
|
|
67
|
+
- [Provider Documentation](https://schemabounce.com/kolumn/docs/providers)
|
|
68
|
+
|
|
69
|
+
## Links
|
|
70
|
+
|
|
71
|
+
- **Website:** https://schemabounce.com
|
|
72
|
+
- **Documentation:** https://schemabounce.com/kolumn/docs
|
|
73
|
+
- **GitHub:** https://github.com/SchemaBounce/Kolumn
|
|
74
|
+
- **Issues:** https://github.com/SchemaBounce/Kolumn/issues
|
|
75
|
+
|
|
76
|
+
## License
|
|
77
|
+
|
|
78
|
+
Apache-2.0
|
package/index.js
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Kolumn - Infrastructure as Code for Database Schema Management
|
|
3
|
+
*
|
|
4
|
+
* The Kolumn CLI is written in Go and available at:
|
|
5
|
+
* https://github.com/SchemaBounce/Kolumn
|
|
6
|
+
*
|
|
7
|
+
* Installation:
|
|
8
|
+
* brew install schemabounce/tap/kolumn
|
|
9
|
+
* # or download from GitHub releases
|
|
10
|
+
*
|
|
11
|
+
* Documentation: https://schemabounce.com/kolumn/docs
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
console.log(`
|
|
15
|
+
╔═══════════════════════════════════════════════════════════════════╗
|
|
16
|
+
║ KOLUMN ║
|
|
17
|
+
║ Infrastructure as Code for Database Schemas ║
|
|
18
|
+
╠═══════════════════════════════════════════════════════════════════╣
|
|
19
|
+
║ ║
|
|
20
|
+
║ Kolumn CLI is written in Go and is NOT an npm package. ║
|
|
21
|
+
║ ║
|
|
22
|
+
║ Install via Homebrew: ║
|
|
23
|
+
║ brew install schemabounce/tap/kolumn ║
|
|
24
|
+
║ ║
|
|
25
|
+
║ Or download from GitHub: ║
|
|
26
|
+
║ https://github.com/SchemaBounce/Kolumn-deploy/releases ║
|
|
27
|
+
║ ║
|
|
28
|
+
║ Documentation: ║
|
|
29
|
+
║ https://schemabounce.com/kolumn/docs ║
|
|
30
|
+
║ ║
|
|
31
|
+
╚═══════════════════════════════════════════════════════════════════╝
|
|
32
|
+
`);
|
|
33
|
+
|
|
34
|
+
module.exports = {
|
|
35
|
+
message: "Kolumn CLI is written in Go. Visit https://github.com/SchemaBounce/Kolumn"
|
|
36
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "kolumn",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Kolumn - Infrastructure as Code for Database Schema Management. Official CLI coming soon.",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"test": "echo \"Kolumn CLI is written in Go. See https://github.com/SchemaBounce/Kolumn\""
|
|
8
|
+
},
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/SchemaBounce/Kolumn.git"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"kolumn",
|
|
15
|
+
"database",
|
|
16
|
+
"schema",
|
|
17
|
+
"infrastructure-as-code",
|
|
18
|
+
"iac",
|
|
19
|
+
"postgresql",
|
|
20
|
+
"mysql",
|
|
21
|
+
"snowflake",
|
|
22
|
+
"cli",
|
|
23
|
+
"schemabounce"
|
|
24
|
+
],
|
|
25
|
+
"author": "SchemaBounce <hello@schemabounce.com>",
|
|
26
|
+
"license": "Apache-2.0",
|
|
27
|
+
"bugs": {
|
|
28
|
+
"url": "https://github.com/SchemaBounce/Kolumn/issues"
|
|
29
|
+
},
|
|
30
|
+
"homepage": "https://schemabounce.com/kolumn"
|
|
31
|
+
}
|