Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Java JDBC read/write pipelines #45

Merged
merged 1 commit into from
Feb 15, 2024
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
7 changes: 7 additions & 0 deletions Java/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,13 @@
<version>${joda.version}</version>
</dependency>

<!-- Adds a dependency for the JDBC. -->
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<version>42.7.1</version>
</dependency>

<!-- Add slf4j API frontend binding with JUL backend -->
<dependency>
<groupId>org.slf4j</groupId>
Expand Down
145 changes: 145 additions & 0 deletions Java/src/main/java/jdbc/ReadPartitionsJdbc.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package jdbc;

import org.apache.beam.sdk.Pipeline;
import org.apache.beam.sdk.io.jdbc.JdbcIO;
import org.apache.beam.sdk.options.Default;
import org.apache.beam.sdk.options.Description;
import org.apache.beam.sdk.options.PipelineOptions;
import org.apache.beam.sdk.options.PipelineOptionsFactory;
import org.apache.beam.sdk.options.Validation;
import org.apache.beam.sdk.transforms.DoFn;
import org.apache.beam.sdk.transforms.ParDo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.Serializable;
import java.sql.ResultSet;
import java.util.Objects;

public class ReadPartitionsJdbc {

private static final Logger LOG = LoggerFactory.getLogger(ReadPartitionsJdbc.class);

/**
* Represents a row in the Example table.
*/
public static class ExampleRow implements Serializable {
public static final String ID_COLUMN = "id";
public static final String NAME_COLUMN = "name";

private int id;
private String name;

public ExampleRow() {}

public ExampleRow(int id, String name) {
this.id = id;
this.name = name;
}

@Override
public String toString() {
return "ExampleRow{" + "id=" + id + ", name='" + name + '\'' + '}';
}
}

/**
* Custom RowMapper for mapping rows from the JDBC result set to ExampleRow objects.
*/
public static class CreateExampleRowOfNameAndId implements JdbcIO.RowMapper<ExampleRow> {
@Override
public ExampleRow mapRow(ResultSet resultSet) throws Exception {
return new ExampleRow(
Long.valueOf(resultSet.getLong(ExampleRow.ID_COLUMN)).intValue(),
resultSet.getString(ExampleRow.NAME_COLUMN));
}
}

/**
* Pipeline options for reading from JDBC.
*/
public interface ReadJdbcOptions extends PipelineOptions {
@Description("Table name to read from")
@Validation.Required
String getTableName();

void setTableName(String tableName);

@Description("JDBC URL")
@Validation.Required
String getJdbcUrl();

void setJdbcUrl(String jdbcUrl);

@Description("")
@Default.String("org.postgresql.Driver")
String getDriverClassName();

void setDriverClassName(String driverClassName);

@Description("DB Username")
@Validation.Required
String getUsername();

void setUsername(String username);

@Description("DB password")
@Validation.Required
String getPassword();

void setPassword(String password);
}

public static void main(String[] args) {
ReadJdbcOptions options =
PipelineOptionsFactory.fromArgs(args).withValidation().as(ReadJdbcOptions.class);

// Configuration for JDBC connection
JdbcIO.DataSourceConfiguration config =
JdbcIO.DataSourceConfiguration.create(options.getDriverClassName(), options.getJdbcUrl())
.withUsername(options.getUsername())
.withPassword(options.getPassword());

Pipeline p = Pipeline.create(options);

p.apply(
"Read from jdbc",
JdbcIO.<ExampleRow>readWithPartitions()
.withDataSourceConfiguration(config)
.withRowMapper(new CreateExampleRowOfNameAndId())
.withTable(options.getTableName())
.withNumPartitions(1)
.withPartitionColumn(ExampleRow.ID_COLUMN)
.withLowerBound(0L)
.withUpperBound(1000L))
.apply(
"Log Data",
ParDo.of(
new DoFn<ExampleRow, ExampleRow>() {
@ProcessElement
public void processElement(ProcessContext c) {
LOG.info(Objects.requireNonNull(c.element()).toString());
c.output(c.element());
}
}));

p.run();
}
}
130 changes: 130 additions & 0 deletions Java/src/main/java/jdbc/WriteJdbc.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package jdbc;

import org.apache.beam.sdk.Pipeline;
import org.apache.beam.sdk.io.jdbc.JdbcIO;
import org.apache.beam.sdk.options.Default;
import org.apache.beam.sdk.options.Description;
import org.apache.beam.sdk.options.PipelineOptions;
import org.apache.beam.sdk.options.PipelineOptionsFactory;
import org.apache.beam.sdk.options.Validation;
import org.apache.beam.sdk.transforms.Create;

import java.io.Serializable;
import java.util.Arrays;
import java.util.List;

public class WriteJdbc {

/**
* Represents a row in the Example table.
*/
public static class ExampleRow implements Serializable {

private int id;
private String name;

public ExampleRow() {}

public ExampleRow(int id, String name) {
this.id = id;
this.name = name;
}

public int getId() {
return id;
}

public String getName() {
return name;
}
}

/**
* Pipeline options for write to JDBC.
*/
public interface WriteJdbcOptions extends PipelineOptions {
@Description("Table name to write to")
@Validation.Required
String getTableName();

void setTableName(String tableName);

@Description("JDBC URL")
@Validation.Required
String getJdbcUrl();

void setJdbcUrl(String jdbcUrl);

@Description("")
@Default.String("org.postgresql.Driver")
String getDriverClassName();

void setDriverClassName(String driverClassName);

@Description("DB Username")
@Validation.Required
String getUsername();

void setUsername(String username);

@Description("DB password")
@Validation.Required
String getPassword();

void setPassword(String password);
}

public static void main(String[] args) {
WriteJdbcOptions options =
PipelineOptionsFactory.fromArgs(args).withValidation().as(WriteJdbcOptions.class);

// Configuration for JDBC connection
JdbcIO.DataSourceConfiguration config =
JdbcIO.DataSourceConfiguration.create(options.getDriverClassName(), options.getJdbcUrl())
.withUsername(options.getUsername())
.withPassword(options.getPassword());

Pipeline p = Pipeline.create(options);

List<ExampleRow> rows = Arrays.asList(
new ExampleRow(1, "Charles"),
new ExampleRow(2, "Alice"),
new ExampleRow(3, "Bob"),
new ExampleRow(4, "Amanda"),
new ExampleRow(5, "Alex"),
new ExampleRow(6, "Eliza")
);

p.apply("Create", Create.of(rows))
.apply(
"Write to JDBC",
JdbcIO.<ExampleRow>write()
.withDataSourceConfiguration(config)
.withStatement(String.format("insert into %s values(?, ?)", options.getTableName()))
.withBatchSize(10L)
.withPreparedStatementSetter(
(element, statement) -> {
statement.setInt(1, element.getId());
statement.setString(2, element.getName());
}));

p.run();
}
}
Loading