A set of parameters for Kinetica.alterTableMetadata(IList<string>,IDictionary<string, string>,IDictionary<string, string>). More...
Inheritance diagram for kinetica.AlterTableMetadataRequest:
Collaboration diagram for kinetica.AlterTableMetadataRequest:
Public Member Functions | |
| AlterTableMetadataRequest () | |
| Constructs an AlterTableMetadataRequest object with default parameters. More... | |
| AlterTableMetadataRequest (IList< string > table_names, IDictionary< string, string > metadata_map, IDictionary< string, string > options=null) | |
| Constructs an AlterTableMetadataRequest object with the specified parameters. More... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| IList< string > | table_names [get, set] |
| Names of the tables whose metadata will be updated. More... | |
| IDictionary< string, string > | metadata_map = new List<string>() [get, set] |
| A map which contains the metadata of the tables that are to be updated. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static RecordSchema | SchemaFromType (System.Type t, KineticaType ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.alterTableMetadata(IList<string>,IDictionary<string, string>,IDictionary<string, string>).
Updates (adds or changes) metadata for tables. The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.
Definition at line 23 of file AlterTableMetadata.cs.
Constructor & Destructor Documentation
◆ AlterTableMetadataRequest() [1/2]
|
inline |
Constructs an AlterTableMetadataRequest object with default parameters.
Definition at line 45 of file AlterTableMetadata.cs.
◆ AlterTableMetadataRequest() [2/2]
|
inline |
Constructs an AlterTableMetadataRequest object with the specified parameters.
- Parameters
-
table_names Names of the tables whose metadata will be updated. All specified tables must exist, or an error will be returned. metadata_map A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared. options Optional parameters. The default value is an empty Dictionary.
Definition at line 61 of file AlterTableMetadata.cs.
Property Documentation
◆ metadata_map
|
getset |
A map which contains the metadata of the tables that are to be updated.
Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
Definition at line 36 of file AlterTableMetadata.cs.
◆ options
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 40 of file AlterTableMetadata.cs.
◆ table_names
|
getset |
Names of the tables whose metadata will be updated.
All specified tables must exist, or an error will be returned.
Definition at line 29 of file AlterTableMetadata.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/AlterTableMetadata.cs
