diff --git a/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcReadSchemaTransformProvider.java b/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcReadSchemaTransformProvider.java index 1be672cb9615..b4765f0392c1 100644 --- a/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcReadSchemaTransformProvider.java +++ b/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcReadSchemaTransformProvider.java @@ -114,28 +114,28 @@ public String description() { protected String inheritedDescription( String prettyName, String transformName, String databaseSchema, int defaultJdbcPort) { return String.format( - "Read from a %s source using a SQL query or by directly accessing a single table.\n" - + "\n" + "Read from a %s source using a SQL query or by directly accessing a single table.%n" + + "%n" + "This is a special case of ReadFromJdbc that includes the " - + "necessary %s Driver and classes.\n" - + "\n" - + "An example of using %s with SQL query: ::\n" - + "\n" - + " - type: %s\n" - + " config:\n" - + " url: \"jdbc:%s://my-host:%d/database\"\n" - + " query: \"SELECT * FROM table\"\n" - + "\n" + + "necessary %s Driver and classes.%n" + + "%n" + + "An example of using %s with SQL query: ::%n" + + "%n" + + " - type: %s%n" + + " config:%n" + + " url: \"jdbc:%s://my-host:%d/database\"%n" + + " query: \"SELECT * FROM table\"%n" + + "%n" + "It is also possible to read a table by specifying a table name. For example, the " - + "following configuration will perform a read on an entire table: ::\n" - + "\n" - + " - type: %s\n" - + " config:\n" - + " url: \"jdbc:%s://my-host:%d/database\"\n" - + " table: \"my-table\"\n" - + "\n" - + "#### Advanced Usage\n" - + "\n" + + "following configuration will perform a read on an entire table: ::%n" + + "%n" + + " - type: %s%n" + + " config:%n" + + " url: \"jdbc:%s://my-host:%d/database\"%n" + + " table: \"my-table\"%n" + + "%n" + + "#### Advanced Usage%n" + + "%n" + "It might be necessary to use a custom JDBC driver that is not packaged with this " + "transform. If that is the case, see ReadFromJdbc which " + "allows for more custom configuration.", diff --git a/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcWriteSchemaTransformProvider.java b/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcWriteSchemaTransformProvider.java index 9d4803addf31..6f10df56aab5 100644 --- a/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcWriteSchemaTransformProvider.java +++ b/sdks/java/io/jdbc/src/main/java/org/apache/beam/sdk/io/jdbc/JdbcWriteSchemaTransformProvider.java @@ -119,28 +119,28 @@ public String description() { protected String inheritedDescription( String prettyName, String transformName, String prefix, int port) { return String.format( - "Write to a %s sink using a SQL query or by directly accessing a single table.\n" - + "\n" + "Write to a %s sink using a SQL query or by directly accessing a single table.%n" + + "%n" + "This is a special case of WriteToJdbc that includes the " - + "necessary %s Driver and classes.\n" - + "\n" - + "An example of using %s with SQL query: ::\n" - + "\n" - + " - type: %s\n" - + " config:\n" - + " url: \"jdbc:%s://my-host:%d/database\"\n" - + " query: \"INSERT INTO table VALUES(?, ?)\"\n" - + "\n" + + "necessary %s Driver and classes.%n" + + "%n" + + "An example of using %s with SQL query: ::%n" + + "%n" + + " - type: %s%n" + + " config:%n" + + " url: \"jdbc:%s://my-host:%d/database\"%n" + + " query: \"INSERT INTO table VALUES(?, ?)\"%n" + + "%n" + "It is also possible to read a table by specifying a table name. For example, the " - + "following configuration will perform a read on an entire table: ::\n" - + "\n" - + " - type: %s\n" - + " config:\n" - + " url: \"jdbc:%s://my-host:%d/database\"\n" - + " table: \"my-table\"\n" - + "\n" - + "#### Advanced Usage\n" - + "\n" + + "following configuration will perform a read on an entire table: ::%n" + + "%n" + + " - type: %s%n" + + " config:%n" + + " url: \"jdbc:%s://my-host:%d/database\"%n" + + " table: \"my-table\"%n" + + "%n" + + "#### Advanced Usage%n" + + "%n" + "It might be necessary to use a custom JDBC driver that is not packaged with this " + "transform. If that is the case, see WriteToJdbc which " + "allows for more custom configuration.",