Skip to content

Commit

Permalink
[FLINK-35363] Fix deprecated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
eskabetxe authored and 1996fanrui committed Jul 29, 2024
1 parent 67046e0 commit 9d535c6
Show file tree
Hide file tree
Showing 27 changed files with 32 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ public Builder setDBUrl(String dbURL) {

/**
* optional, Handle the SQL dialect of jdbc driver. If not set, it will be infer by {@link
* JdbcFactoryLoader#load} from DB url.
* JdbcFactoryLoader#loadDialect} from DB url.
*/
public Builder setDialect(JdbcDialect dialect) {
this.dialect = dialect;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@

import javax.sql.XADataSource;

/** Facade to create JDBC {@link SinkFunction sinks}. */
/**
* Facade to create JDBC {@link SinkFunction sinks}.
*
* @deprecated Use {@link org.apache.flink.connector.jdbc.core.datastream.Jdbc}
*/
@PublicEvolving
@Deprecated
public class JdbcSink {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/**
* Abstract catalog for any JDBC catalogs.
*
* @deprecated use org.apache.flink.connector.jdbc.core.table.catalog.AbstractJdbcCatalog
* @deprecated Use {@link org.apache.flink.connector.jdbc.core.database.catalog.AbstractJdbcCatalog}
*/
@Deprecated
public abstract class AbstractJdbcCatalog
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
/**
* Catalogs for relational databases via JDBC.
*
* @deprecated user org.apache.flink.connector.jdbc.core.table.catalog.JdbcCatalog
* @deprecated Use {@link org.apache.flink.connector.jdbc.core.database.catalog.JdbcCatalog}
*/
@Deprecated
@PublicEvolving
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@
/**
* Factory for {@link JdbcCatalog}.
*
* @deprecated use org.apache.flink.connector.jdbc.core.table.catalog.factory.JdbcCatalogFactory
* @deprecated Use {@link
* org.apache.flink.connector.jdbc.core.database.catalog.factory.JdbcCatalogFactory}.
*/
@Deprecated
public class JdbcCatalogFactory implements CatalogFactory {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
/**
* Base class for all converters that convert between JDBC object and Flink internal object.
*
* @deprecated use AbstractDialectConverter
* @deprecated Use {@link AbstractDialectConverter}
*/
@Deprecated
public abstract class AbstractJdbcRowConverter extends AbstractDialectConverter {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* Converter that is responsible to convert between JDBC object and Flink SQL internal data
* structure {@link RowData}.
*
* @deprecated use JdbcDialectConverter
* @deprecated Use {@link JdbcDialectConverter}
*/
@Deprecated
@PublicEvolving
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* <p>Implementors should be careful to check the default SQL statements are performant for their
* specific dialect and override them if necessary.
*
* @deprecated use org.apache.flink.connector.jdbc.core.table.dialect.AbstractDialect
* @deprecated Use {@link org.apache.flink.connector.jdbc.core.database.dialect.AbstractDialect}
*/
@Deprecated
@PublicEvolving
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* and stateless.
*
* @see JdbcFactory
* @deprecated use org.apache.flink.connector.jdbc.core.table.dialect.JdbcDialect
* @deprecated Use {@link org.apache.flink.connector.jdbc.core.database.dialect.JdbcDialect}
*/
@Deprecated
@PublicEvolving
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* current classpath to be found.
*
* @see org.apache.flink.connector.jdbc.dialect.JdbcDialect
* @deprecated use JdbcFactory
* @deprecated Use {@link JdbcFactory}
*/
@Deprecated
public interface JdbcDialectFactory extends JdbcFactory {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* Separate the jdbc meta-information type to flink table type into the interface.
*
* @deprecated use JdbcCatalogTypeMapper
* @deprecated Use {@link JdbcCatalogTypeMapper}
*/
@Deprecated
public interface JdbcDialectTypeMapper extends JdbcCatalogTypeMapper {}
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
* Flink Sink to produce data into a jdbc database.
*
* @see JdbcSinkBuilder on how to construct a JdbcSink
* @deprecated please use {@link org.apache.flink.connector.jdbc.core.datastream.sink.JdbcSink}
* @deprecated Use {@link org.apache.flink.connector.jdbc.core.datastream.sink.JdbcSink}
*/
@PublicEvolving
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@
/**
* Builder to construct {@link JdbcSink}.
*
* @deprecated please use {@link
* org.apache.flink.connector.jdbc.core.datastream.sink.JdbcSinkBuilder}
* @deprecated Use {@link org.apache.flink.connector.jdbc.core.datastream.sink.JdbcSinkBuilder}
*/
@PublicEvolving
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
/**
* JDBC source.
*
* @deprecated please use {@link org.apache.flink.connector.jdbc.core.datastream.source.JdbcSource}
* @deprecated Use {@link org.apache.flink.connector.jdbc.core.datastream.source.JdbcSource}
*/
@PublicEvolving
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,7 @@
* @see PreparedStatement
* @see DriverManager
* @see JdbcSource
* @deprecated please use {@link
* org.apache.flink.connector.jdbc.core.datastream.source.JdbcSourceBuilder}
* @deprecated Use {@link org.apache.flink.connector.jdbc.core.datastream.source.JdbcSourceBuilder}
*/
@PublicEvolving
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* The Extractor to extract the data from {@link ResultSet}.
*
* @param <T> The target data type.
* @deprecated please use {@link
* @deprecated Use {@link
* org.apache.flink.connector.jdbc.core.datastream.source.reader.extractor.ResultExtractor}
*/
@PublicEvolving
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* Options for the JDBC connector.
*
* @deprecated please use {@link org.apache.flink.connector.jdbc.core.table.JdbcConnectorOptions}
* @deprecated Use {@link org.apache.flink.connector.jdbc.core.table.JdbcConnectorOptions}
*/
@PublicEvolving
@Deprecated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import org.apache.flink.connector.jdbc.datasource.transactions.xa.xid.XaXidTest;

/** XaSerializersTest. */
@Deprecated
class CheckpointAndXidSerializersTest extends SerializerTestBase<CheckpointAndXid> {
private static final CheckpointAndXid CHECKPOINT_AND_XID =
CheckpointAndXid.createRestored(1L, 1, XaXidTest.XID);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@
import static org.assertj.core.api.Assertions.assertThat;

/** A simple end-to-end test for {@link JdbcXaSinkFunction}. */
@Deprecated
public abstract class JdbcExactlyOnceSinkE2eTest implements DatabaseTest {

private static final Logger LOG = LoggerFactory.getLogger(JdbcExactlyOnceSinkE2eTest.class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import static org.mockito.Mockito.when;

/** {@link XaFacadeImpl} tests. */
@Deprecated
class JdbcXaFacadeImplTest extends JdbcTestBase {

private static final Xid XID =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import static org.apache.flink.connector.jdbc.JdbcTestFixture.TEST_DATA;
import static org.assertj.core.api.Assertions.assertThat;

@Deprecated
class JdbcXaFacadeTestHelper implements AutoCloseable {
private final String table;
private final DatabaseMetadata metadata;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
* {@link JdbcXaSinkFunction} tests using Derby DB. Derby supports XA but doesn't use MVCC, so we
* can't check anything before all transactions are completed.
*/
@Deprecated
class JdbcXaSinkDerbyTest extends JdbcXaSinkTestBase {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
* transaction is not yet committed). But XA support isn't full, so for some scenarios {@link
* H2XaDsWrapper wrapper} is used, and for some - Derby.
*/
@Deprecated
class JdbcXaSinkH2Test extends JdbcXaSinkTestBase implements H2XaTestBase {

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import static org.assertj.core.api.Assertions.assertThat;

/** Tests that data is not inserted ahead of time. */
@Deprecated
class JdbcXaSinkNoInsertionTest extends JdbcXaSinkTestBase implements H2XaTestBase {

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
* // todo: javadoc case Base class for {@link JdbcXaSinkFunction} tests. In addition to {@link
* JdbcTestBase} init it initializes/closes helpers.
*/
@Deprecated
abstract class JdbcXaSinkTestBase extends JdbcTestBase {

JdbcXaFacadeTestHelper xaHelper;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import static org.apache.flink.connector.jdbc.JdbcTestFixture.TEST_DATA;
import static org.apache.flink.connector.jdbc.xa.JdbcXaSinkTestBase.TEST_SINK_CONTEXT;

@Deprecated
class JdbcXaSinkTestHelper implements AutoCloseable {

private final JdbcXaSinkFunction<TestEntry> sink;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import static org.assertj.core.api.Assertions.assertThat;

/** Simple uniqueness tests for the {@link SemanticXidGenerator}. */
@Deprecated
class SemanticXidGeneratorTest {
private static final int COUNT = 100_000;

Expand Down

0 comments on commit 9d535c6

Please sign in to comment.