{"id":13740492,"url":"https://github.com/elan8/propanedb","last_synced_at":"2026-04-04T18:39:11.431Z","repository":{"id":44588623,"uuid":"377918765","full_name":"elan8/propanedb","owner":"elan8","description":"A document database for Protocol Buffer messages with GRPC interface","archived":false,"fork":false,"pushed_at":"2022-02-06T16:56:39.000Z","size":439,"stargazers_count":11,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-04T04:06:41.180Z","etag":null,"topics":["database","grpc","protobuf","protocol-buffers"],"latest_commit_sha":null,"homepage":"https://www.propanedb.com","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/elan8.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-17T17:58:32.000Z","updated_at":"2024-05-22T07:26:14.000Z","dependencies_parsed_at":"2022-09-08T09:11:28.249Z","dependency_job_id":null,"html_url":"https://github.com/elan8/propanedb","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elan8%2Fpropanedb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elan8%2Fpropanedb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elan8%2Fpropanedb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elan8%2Fpropanedb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elan8","download_url":"https://codeload.github.com/elan8/propanedb/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224765481,"owners_count":17366127,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","grpc","protobuf","protocol-buffers"],"created_at":"2024-08-03T04:00:48.611Z","updated_at":"2024-11-15T10:30:44.751Z","avatar_url":"https://github.com/elan8.png","language":"C++","funding_links":[],"categories":["Tools"],"sub_categories":["Other"],"readme":"[![Codacy Badge](https://app.codacy.com/project/badge/Grade/f8495be580014d2d873e820ed36835e0)](https://app.codacy.com/gh/elan8/propanedb/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/f8495be580014d2d873e820ed36835e0)](https://app.codacy.com/gh/elan8/propanedb/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_coverage)\n\n# PropaneDB\nA document database for Protocol Buffer messages with GRPC interface\n\nIdeal for GRPC microservices: \n- Use the messages defined in the proto file both for communication and storage: single source of truth\n- Can be used with any programming language that is supported by GRPC \n\nFeatures:\n- Store Protobuf objects in serialized form (google.protobuf.Any) in a database\n- Retrieve those objects using their UUID\n- Delete objects based on their UUID  \n- Search function based on the fields of the Protobuf objects\n- Support multiple databases per instance\n- Backup and restore functionality\n\n## Getting started\nIn order to use PropaneDB with your application, you can use the Golang driver.\n1. First define your messages and RPC's in a .proto file and generate GRPC code and a Descriptor file:\n```\nprotoc  --go_out=:. --go-grpc_out=:. --descriptor_set_out=./propane/test.bin -I.  ./api/test.proto\n```\n2. Open a terminal and use the following command to start an instance of PropaneDB\n```\ndocker run -p=50051:50051  ghcr.io/elan8/propanedb:latest\n```\n3. First import the driver in your Go app and other dependencies (assuming you are using Go modules)\n```\nimport (\n\t\"context\"\n\t\"log\"\n\t\"io/ioutil\"\n\n\t\"github.com/elan8/propanedb-go-driver/propane\"\n\t\"google.golang.org/protobuf/proto\"\n\t\"google.golang.org/protobuf/types/descriptorpb\"\n)\n```\n4. Connect to PropaneDB and create a database\n```\n\tdatabaseName := \"test\"\n\tctx := context.Background()\n        port := \"50051\"\n\n\tb, err := ioutil.ReadFile(\"../propane/test.bin\")\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %s\", err)\n\t}\n\n\tfds := \u0026descriptorpb.FileDescriptorSet{}\n\tproto.Unmarshal(b, fds)\n\n\tclient, err := propane.Connect(ctx, \"localhost:\"+port)\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %s\", err)\n\t}\n\terr = client.CreateDatabase(ctx, databaseName, fds)\n\tif err != nil {\n\t\tlog.Printf(\"Error: %s\", err)\n\t}\n```\n5. Instantiate a Protobuf message (=struct in Go) that you previously defined in your .proto file and store it in the database:\n```\n\titem1 := \u0026propane.TestEntity{}\n\titem1.Description = \"Test 1\"\n\tid1, err := client.Put(ctx, item1)\n\tif err != nil {\n\t\tlog.Fatalf(\"Error: %s\", err)\n\t}\n\tlog.Print(\"Id1=\" + id1)\n```\n\n## Related projects\n- [Golang driver](https://github.com/elan8/propanedb-go-driver)\n- [Demo](https://github.com/elan8/propanedb-demo)\n\n## Implementation\n- Storage engine is RocksDB.\n- Interface is based on GRPC\n- Deployment using Docker containers\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felan8%2Fpropanedb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felan8%2Fpropanedb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felan8%2Fpropanedb/lists"}