[IGNITE-23185] Add tableDefinition and zoneDefinition methods to IgniteCatalog

• Type: Improvement
• Status: Patch Available
• Priority: Major
• Resolution: Unresolved
• Fix Version/s: 3.1
• Component/s: sql
• Labels: ignite-3
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Mikhail Pochatkin
• Reporter: Pavel Tupitsyn
• Created: 11/Sep/24 07:56
• Updated: 2 days ago 10:11

Description

IgniteCatalog API allows creating tables using a strongly-typed object model (generates and executes SQL for you from a TableDefinition).

However, there is no way to get the TableDefinition for an existing table. Use cases:

• Inspect table information in a strongly-typed way (as opposed to executing an Ignite-specific SQL query and extracting the data from a ResultSet)
• Get the definition of an existing table and create another one with similar settings (using TableDefinition.toBuilder)

Same applies to ZoneDefinition.

Extend IgniteCatalog interface with the following methods:

    CompletableFuture<TableDefinition> tableDefinitionAsync(String name);
    TableDefinition tableDefinition(String name);
    
    CompletableFuture<ZoneDefinition> zoneDefinitionAsync(String name);
    ZoneDefinition zoneDefinition(String name);

Issue Links

• links to: GitHub Pull Request #4452