Skip to content

Commit 3a305ba

Browse files
authored
docs: add simple connection sample to readme (#263)
Adds a simple code example for connecting to Cloud Spanner using JDBC. Also fixes a wrong link to the online documentation.
1 parent c6e7c3b commit 3a305ba

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,30 @@ See the [Google Cloud Spanner JDBC client library docs][javadocs] to learn how t
5858
use this Google Cloud Spanner JDBC Client Library.
5959

6060

61-
62-
61+
### Creating a JDBC Connection
62+
63+
The following example shows how to create a JDBC connection to Cloud Spanner and execute a simple query.
64+
65+
```java
66+
String projectId = "my-project";
67+
String instanceId = "my-instance";
68+
String databaseId = "my-database";
69+
70+
try (Connection connection =
71+
DriverManager.getConnection(
72+
String.format(
73+
"jdbc:cloudspanner:/projects/%s/instances/%s/databases/%s",
74+
projectId, instanceId, databaseId))) {
75+
try (Statement statement = connection.createStatement()) {
76+
try (ResultSet rs = statement.executeQuery("SELECT CURRENT_TIMESTAMP()")) {
77+
while (rs.next()) {
78+
System.out.printf(
79+
"Connected to Cloud Spanner at [%s]%n", rs.getTimestamp(1).toString());
80+
}
81+
}
82+
}
83+
}
84+
```
6385

6486

6587
## Troubleshooting
@@ -101,7 +123,7 @@ Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
101123
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
102124
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
103125

104-
[product-docs]: https://cloud.google.com/pubsub/docs/
126+
[product-docs]: https://cloud.google.com/spanner/docs/use-oss-jdbc
105127
[javadocs]: https://googleapis.dev/java/google-cloud-spanner-jdbc/latest/index.html
106128
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-spanner-jdbc/java7.svg
107129
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-spanner-jdbc/java7.html

0 commit comments

Comments
 (0)