dial_options_example_test.go

/*
 * SPDX-FileCopyrightText: © 2017-2026 Istari Digital, Inc.
 * SPDX-License-Identifier: Apache-2.0
 */

package modusgraph_test

import (
	"time"

	mg "github.com/matthewmcneely/modusgraph"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials/insecure"
	"google.golang.org/grpc/keepalive"
)

// ExampleWithGRPCDialOption configures gRPC dial settings the dedicated options
// do not cover — here, transport credentials and keepalive parameters — when
// opening a remote dgraph:// connection. Each WithGRPCDialOption adds one
// grpc.DialOption; they compose with WithMaxRecvMsgSize. The options are ignored
// for embedded (file://) URIs.
func ExampleWithGRPCDialOption() {
	client, err := mg.NewClient(
		"dgraph://localhost:9080",
		mg.WithGRPCDialOption(grpc.WithTransportCredentials(insecure.NewCredentials())),
		mg.WithGRPCDialOption(grpc.WithKeepaliveParams(keepalive.ClientParameters{
			Time:    30 * time.Second,
			Timeout: 10 * time.Second,
		})),
	)
	if err != nil {
		panic(err)
	}
	defer client.Close()
}