Package org.apache.iceberg.view
Interface ViewBuilder
-
- All Superinterfaces:
VersionBuilder<ViewBuilder>
- All Known Implementing Classes:
BaseMetastoreViewCatalog.BaseViewBuilder
public interface ViewBuilder extends VersionBuilder<ViewBuilder>
A builder used to create or replace a SQLView
.Call
ViewCatalog.buildView(org.apache.iceberg.catalog.TableIdentifier)
to create a new builder.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description View
create()
Create the view.View
createOrReplace()
Create or replace the view.View
replace()
Replace the view.default ViewBuilder
withLocation(java.lang.String location)
Sets a location for the viewViewBuilder
withProperties(java.util.Map<java.lang.String,java.lang.String> properties)
Add key/value properties to the view.ViewBuilder
withProperty(java.lang.String key, java.lang.String value)
Add a key/value property to the view.-
Methods inherited from interface org.apache.iceberg.view.VersionBuilder
withDefaultCatalog, withDefaultNamespace, withQuery, withSchema
-
-
-
-
Method Detail
-
withProperties
ViewBuilder withProperties(java.util.Map<java.lang.String,java.lang.String> properties)
Add key/value properties to the view.- Parameters:
properties
- key/value properties- Returns:
- this for method chaining
-
withProperty
ViewBuilder withProperty(java.lang.String key, java.lang.String value)
Add a key/value property to the view.- Parameters:
key
- a keyvalue
- a value- Returns:
- this for method chaining
-
withLocation
default ViewBuilder withLocation(java.lang.String location)
Sets a location for the view- Parameters:
location
- the location to set for the view- Returns:
- this for method chaining
-
create
View create()
Create the view.- Returns:
- the view created
-
-