Package oracle.pgx.config

Class AbstractFileEntityProviderConfig

    • Constructor Detail

      • AbstractFileEntityProviderConfig

        public AbstractFileEntityProviderConfig()

    • Method Detail

      • getUris

        public abstract java.util.List<java.lang.String> getUris()
        Get the unified resource identifiers for the files with the table data
        Returns:
        the list of URIs

      • getStoringOptions

        public FileGraphStoringConfig getStoringOptions()
        Get the storing configuration
        Returns:
        the storing configuration

      • getAttributes

        public abstract java.util.Map getAttributes()
        Get the file-system specific additional attributes needed to read/write the table data
        Returns:
        the map of attributes

      • getSeparator

        public abstract java.lang.String getSeparator()
        Get the separator of this table configuration
        Returns:
        the separator

      • isDetectGzip

        public abstract java.lang.Boolean isDetectGzip()
        Whether GZip file automatic detection is enabled or not.
        Returns:
        true if GZip file automatic detection is enabled, false otherwise.

      • isHeader

        public abstract java.lang.Boolean isHeader()
        Whether the file has a header. i.e. first line of file is meant for headers, e.g. 'EdgeId, SourceId, DestId, EdgeProp1, EdgeProp2'
        Returns:
        Whether the file has a header or not

      • getKeyColumn

        public abstract java.lang.Object getKeyColumn()
        name or index (starting from 1) of column corresponding to keys (for CSV format only)
        See Also:
        validating version of this API

      • getSourceColumn

        public abstract java.lang.Object getSourceColumn()
        name or index (starting from 1) of column corresponding to edge source (for CSV format only)
        See Also:
        validating version of this API

      • getSourceKeyColumns

        @BetaApi
public abstract java.util.List<? extends ForeignKeyColumnDescriptor> getSourceKeyColumns()
        Get the source key declaration associated with this entity provider config. A source key is composed of one or more source key columns, each referring to one key column of the source vertex provider. Use getValidatedSourceKeyColumns() ()} instead of this function, as that function will also consider legacy configs.
        Returns:
        Source key columns declared in the config.
        Since:
        25.2.0

      • getValidatedSourceKeyColumns

        @BetaApi
public java.util.List<? extends ForeignKeyColumnDescriptor> getValidatedSourceKeyColumns()
        Validate and get the source key declaration associated with this provider configuration. This function will use the source key returned by either getSourceKeyColumns() or legacy function.
        Returns:
        A list of validated foreign key column descriptors.
        Since:
        25.2.0

      • getDestinationColumn

        public abstract java.lang.Object getDestinationColumn()
        name or index (starting from 1) of column corresponding to edge destination (for CSV format only)
        See Also:
        validating version of this API

      • getDestinationKeyColumns

        @BetaApi
public abstract java.util.List<? extends ForeignKeyColumnDescriptor> getDestinationKeyColumns()
        Get the destination key declaration associated with this entity provider config. A destination key is composed of one or more destination key columns, each referring to one key column of the destination vertex provider. Use getValidatedDestinationKeyColumns() instead of this function, as that function will also consider legacy configs.
        Returns:
        Destination key columns declared in the config.
        Since:
        25.2.0

      • getValidatedDestinationKeyColumns

        @BetaApi
public java.util.List<? extends ForeignKeyColumnDescriptor> getValidatedDestinationKeyColumns()
        Validate and get the source key declaration associated with this provider configuration. This function will use the source key returned by either getDestinationKeyColumns() or legacy function.
        Returns:
        A list of validated foreign key column descriptors.
        Since:
        25.2.0