Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/reference/go/sql/sql-connection-string.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
description: "Reference for Nitric's Go library - Returns the connection string for a SQL database at runtime."
---

# Go - SqlDatabase.ConnectionString()

Returns the connection string for a SQL database at runtime.

```go
import (
"context"

"github.com/nitrictech/go-sdk/nitric"
)

func main() {
db := nitric.NewSqlDatabase("my-database")

// Should be called at runtime, such as in a service handler
connStr, _ := db.ConnectionString(context.TODO())

nitric.Run()
}
```

## Examples

### Return a connection string

```go
import (
"context"

"github.com/nitrictech/go-sdk/nitric"
)

func main() {
db := nitric.NewSqlDatabase("my-database")

// Should be called at runtime, such as in a service handler
connStr, _ := db.ConnectionString(context.TODO())

nitric.Run()
}
```
85 changes: 85 additions & 0 deletions docs/reference/go/sql/sql.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
description: "Reference for Nitric's Go library - Creates a reference to a SQL database."
---

# Go - NewSqlDatabase()

Creates a reference to a SQL database.

```go
import (
"github.com/nitrictech/go-sdk/nitric"
)

db := nitric.NewSqlDatabase("my-database")
```

## Parameters

<Properties>
<Property name="name" required type="string">
The unique name of this database within the project.
</Property>
<Property name="options" type="...sqlDatabaseOption">
Additional options for the SQL Database. See below.
</Property>
</Properties>

### SQL Database options

<Properties>
<Property name="WithMigrationsPath()" type="sqlDatabaseOption">
<Properties nested>
<Property name="path" required type="string">
Points to the location of migration files, prefixed with `file://`, or a
migration dockerfile, prefixed with `dockerfile://`.
</Property>
</Properties>
</Property>
</Properties>

## Examples

### Create a reference to a database

```go
import (
"github.com/nitrictech/go-sdk/nitric"
)

db := nitric.NewSqlDatabase("my-database")
```

### With a migrations directory

```go
import (
"github.com/nitrictech/go-sdk/nitric"
"github.com/nitrictech/go-sdk/nitric/sql"
)

func main() {
db := nitric.NewSqlDatabase("my-database", sql.WithMigrationsPath("file://migrations/my-database"))

nitric.Run()
}
```

### With a migrations dockerfile

```go
import (
"github.com/nitrictech/go-sdk/nitric"
"github.com/nitrictech/go-sdk/nitric/sql"
)

func main() {
db := nitric.NewSqlDatabase("my-database", sql.WithMigrationsPath("dockerfile://migrations.dockerfile"))

nitric.Run()
}
```

### See also

- [SqlDatabase.ConnectionString()](./sql-connection-string)
8 changes: 2 additions & 6 deletions docs/reference/nodejs/sql/sql-connection-string.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,8 @@ const connStr = await db.connectionString()

### Connect with Prisma

```javascript file=<rootDir>/src/assets/snippets/sql-prisma-snippet.js

```
<ImportCode file="/src/assets/snippets/sql-prisma-snippet.js" />

### Connect with Drizzle

```javascript file=<rootDir>/src/assets/snippets/sql-drizzle-snippet.js

```
<ImportCode file="/src/assets/snippets/sql-drizzle-snippet.js" />
8 changes: 2 additions & 6 deletions docs/reference/nodejs/sql/sql.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,11 @@ const db = sql('my-data', {

### Connect with Prisma

```javascript file=<rootDir>/src/assets/snippets/sql-prisma-snippet.js

```
<ImportCode file="/src/assets/snippets/sql-prisma-snippet.js" />

### Connect with Drizzle

```javascript file=<rootDir>/src/assets/snippets/sql-drizzle-snippet.js

```
<ImportCode file="/src/assets/snippets/sql-drizzle-snippet.js" />

### See also

Expand Down
13 changes: 13 additions & 0 deletions src/config/reference/go.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ export const GoReference: NavGroup = {
title: 'NewSecret()',
href: '/reference/go/secrets/secret',
},
{
title: 'NewSqlDatabase()',
href: '/reference/go/sql/sql',
},
{
title: 'NewBucket()',
href: '/reference/go/storage/bucket',
Expand Down Expand Up @@ -215,6 +219,15 @@ export const GoReference: NavGroup = {
},
],
},
{
title: 'SQL',
items: [
{
title: 'SqlDatabase.ConnectionString()',
href: '/reference/go/sql/sql-connection-string',
},
],
},
{
title: 'Schedules',
items: [
Expand Down
Loading