graphdblite 0.1.2

Embedded graph database with Cypher support. SQLite-grade simplicity, graph-native performance.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# graphdblite Go binding

User-facing docs: [../../docs/go.md](../../docs/go.md). This file covers
the binding's *build layout* — what lives where and how `go get` is
expected to work end-to-end.

## Layout

```
bindings/go/
├── graphdblite.go        # cgo wrapper around libgraphdblite_ffi
├── Makefile              # local dev builds (detects host triple)
└── lib/
    ├── linux_amd64/      # libgraphdblite_ffi.a (committed at release time)
    ├── linux_arm64/
    ├── darwin_arm64/
    └── windows_amd64/
```

## How cgo finds the static lib

`graphdblite.go` carries per-platform `#cgo` directives:

```c
#cgo linux,amd64   LDFLAGS: -L${SRCDIR}/lib/linux_amd64   -lgraphdblite_ffi -lm -ldl -lpthread
#cgo linux,arm64   LDFLAGS: -L${SRCDIR}/lib/linux_arm64   -lgraphdblite_ffi -lm -ldl -lpthread
#cgo darwin,arm64  LDFLAGS: -L${SRCDIR}/lib/darwin_arm64  -lgraphdblite_ffi -lm
#cgo windows,amd64 LDFLAGS: -L${SRCDIR}/lib/windows_amd64 -lgraphdblite_ffi -lws2_32 -luserenv -lntdll -ladvapi32 -lbcrypt
```

`${SRCDIR}` resolves to this directory at cgo-compile time, so the
toolchain picks the matching `lib/<os_arch>/libgraphdblite_ffi.a` for
the host. This is what makes `go get
github.com/ds7n/graphdblite/bindings/go` work without a Rust toolchain
on the consumer's machine.

## Local development (`make build`)

`make build` detects the host triple via `uname` and drops the freshly
compiled `libgraphdblite_ffi.{a,so,dylib}` into `lib/<os_arch>/`. Any
`lib/**/*.{a,so,dylib,dll,lib}` is gitignored, so local rebuilds never
pollute the tracked tree; release-time per-platform archives are
staged explicitly via `git add -f`.

## Release lib population

At release time, `scripts/populate-go-libs.sh` downloads the four
`graphdblite-ffi-<triple>.{tar.gz,zip}` archives from the GitHub
release and unpacks each one into the right `lib/<os_arch>/` subdir,
then force-stages them for the release commit. The full release
sequence lives in [`docs/publishing.md`](../../docs/publishing.md).

## Supported platforms

| `GOOS` | `GOARCH` | Status |
|---|---|---|
| `linux`   | `amd64` | supported |
| `linux`   | `arm64` | supported |
| `darwin`  | `arm64` | supported (Apple Silicon only) |
| `windows` | `amd64` | supported (uses MinGW-built FFI, `x86_64-pc-windows-gnu`) |

Out of scope for now: Intel Macs (`darwin/amd64`), 32-bit Linux,
`armv7`. Adding any of these requires (a) cross-build coverage in
`.github/workflows/dev-build.yml` and (b) a matching cgo `LDFLAGS`
line in `graphdblite.go`.