-
Notifications
You must be signed in to change notification settings - Fork 13k
/
DynamicTableFactory.java
78 lines (69 loc) · 2.63 KB
/
DynamicTableFactory.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*
* 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 org.apache.flink.table.factories;
import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.configuration.ReadableConfig;
import org.apache.flink.table.catalog.Catalog;
import org.apache.flink.table.catalog.CatalogTable;
import org.apache.flink.table.catalog.ObjectIdentifier;
import org.apache.flink.table.connector.sink.DynamicTableSink;
import org.apache.flink.table.connector.source.DynamicTableSource;
/**
* Base interface for configuring a dynamic table connector for an external storage system from catalog
* and session information.
*
* <p>Dynamic tables are the core concept of Flink's Table & SQL API for processing both bounded and
* unbounded data in a unified fashion.
*
* <p>Implement {@link DynamicTableSourceFactory} for constructing a {@link DynamicTableSource}.
*
* <p>Implement {@link DynamicTableSinkFactory} for constructing a {@link DynamicTableSink}.
*
* <p>The options {@link FactoryUtil#PROPERTY_VERSION} and {@link FactoryUtil#CONNECTOR} are implicitly
* added and must not be declared.
*/
@PublicEvolving
public interface DynamicTableFactory extends Factory {
/**
* Provides catalog and session information describing the dynamic table to be accessed.
*/
interface Context {
/**
* Returns the identifier of the table in the {@link Catalog}.
*/
ObjectIdentifier getObjectIdentifier();
/**
* Returns table information received from the {@link Catalog}.
*/
CatalogTable getCatalogTable();
/**
* Gives read-only access to the configuration of the current session.
*/
ReadableConfig getConfiguration();
/**
* Returns the class loader of the current session.
*
* <p>The class loader is in particular useful for discovering further (nested) factories.
*/
ClassLoader getClassLoader();
/**
* Whether the table is temporary.
*/
boolean isTemporary();
}
}