avrotize 2.22.2__py3-none-any.whl → 3.0.0__py3-none-any.whl

avrotize/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '2.22.2'
-__version_tuple__ = version_tuple = (2, 22, 2)
+__version__ = version = '3.0.0'
+__version_tuple__ = version_tuple = (3, 0, 0)
 
 __commit_id__ = commit_id = None

avrotize/avrotocsv.py

@@ -39,7 +39,23 @@ class AvroToCSVSchemaConverter:
 
         :param avro_schema: Avro schema as a dictionary.
         :return: CSV schema as a dictionary.
+        :raises ValueError: If the schema is not a single record type.
         """
+        # Handle schema arrays (unions of records) - not supported
+        if isinstance(avro_schema, list):
+            raise ValueError(
+                "CSV schema conversion only supports single record schemas. "
+                "The provided schema is an array/union of multiple types. "
+                "Use --record-type to specify a single record type if available."
+            )
+        
+        # Ensure it's a record type with fields
+        if not isinstance(avro_schema, dict) or 'fields' not in avro_schema:
+            raise ValueError(
+                "CSV schema conversion only supports Avro record types with 'fields'. "
+                f"The provided schema has type: {avro_schema.get('type', 'unknown') if isinstance(avro_schema, dict) else type(avro_schema).__name__}"
+            )
+        
         csv_schema = {
             "fields": []
         }

avrotize/commands.json

@@ -649,6 +649,108 @@
       }
     ]
   },
+  {
+    "command": "s2k",
+    "description": "Convert JSON Structure schema to Kusto table schemas",
+    "group": "4_RTDB",
+    "function": {
+      "name": "avrotize.structuretokusto.convert_structure_to_kusto",
+      "args": {
+        "structure_schema_path": "input_file_path",
+        "kusto_file_path": "output_file_path",
+        "kusto_uri": "args.kusto_uri",
+        "kusto_database": "args.kusto_database",
+        "structure_record_type": "args.record_type",
+        "emit_cloudevents_columns": "args.emit_cloudevents_columns",
+        "emit_cloudevents_dispatch_table": "args.emit_cloudevents_dispatch"
+      }
+    },
+    "extensions": [
+      ".struct.json",
+      ".json"
+    ],
+    "args": [
+      {
+        "name": "input",
+        "type": "str",
+        "nargs": "?",
+        "help": "Path to the JSON Structure schema file (or read from stdin if omitted)",
+        "required": false
+      },
+      {
+        "name": "--out",
+        "type": "str",
+        "help": "Path to the Kusto table schema file",
+        "required": false
+      },
+      {
+        "name": "--struct",
+        "type": "str",
+        "help": "Deprecated: Path to the JSON Structure schema file (for backcompat)",
+        "required": false
+      },
+      {
+        "name": "--kusto-uri",
+        "type": "str",
+        "help": "Kusto Cluster URI to apply the generated schema to.",
+        "required": false
+      },
+      {
+        "name": "--kusto-database",
+        "type": "str",
+        "help": "Kusto database name to apply the generated schema to",
+        "required": false
+      },
+      {
+        "name": "--record-type",
+        "type": "str",
+        "help": "Record type in the JSON Structure schema",
+        "required": false
+      },
+      {
+        "name": "--emit-cloudevents-columns",
+        "type": "bool",
+        "help": "Add CloudEvents columns to the Kusto table",
+        "default": false,
+        "required": false
+      },
+      {
+        "name": "--emit-cloudevents-dispatch",
+        "type": "bool",
+        "help": "Emit a _cloudevents_dispatch ingestion table and update policies for each generated table",
+        "required": false
+      }
+    ],
+    "suggested_output_file_path": "{input_file_name}.kql",
+    "prompts": [
+      {
+        "name": "--kusto-uri",
+        "message": "Enter the Kusto Cluster URI (optional)",
+        "type": "str",
+        "required": false
+      },
+      {
+        "name": "--kusto-database",
+        "message": "Enter the Kusto database name (optional)",
+        "type": "str",
+        "required": false
+      },
+      {
+        "name": "--emit-cloudevents-columns",
+        "message": "Add CloudEvents columns to the Kusto table?",
+        "type": "bool",
+        "default": false,
+        "required": false
+      },
+      {
+        "name": "--emit-cloudevents-dispatch",
+        "message": "Emit a _cloudevents_dispatch ingestion table and update policies?",
+        "type": "bool",
+        "default": false,
+        "required": false
+      }
+    ]
+  },
   {
     "command": "k2a",
     "description": "Convert Kusto schema to Avrotize schema",
@@ -836,7 +938,7 @@
     ]
   },
   {
-    "command": "struct2sql",
+    "command": "s2sql",
     "description": "Convert JSON Structure schema to SQL schema",
     "group": "5_SQL",
     "function": {
@@ -1821,6 +1923,44 @@
     "suggested_output_file_path": "{input_file_name}.csv.json",
     "prompts": []
   },
+  {
+    "command": "a2csv",
+    "description": "Convert Avrotize schema to CSV schema",
+    "group": "1_Schemas",
+    "function": {
+      "name": "avrotize.avrotocsv.convert_avro_to_csv_schema",
+      "args": {
+        "avro_schema_path": "input_file_path",
+        "csv_schema_path": "output_file_path"
+      }
+    },
+    "extensions": [
+      ".avsc"
+    ],
+    "args": [
+      {
+        "name": "input",
+        "type": "str",
+        "nargs": "?",
+        "help": "Path to the Avrotize schema file (or read from stdin if omitted)",
+        "required": false
+      },
+      {
+        "name": "--out",
+        "type": "str",
+        "help": "Output path for the CSV schema file",
+        "required": false
+      },
+      {
+        "name": "--avsc",
+        "type": "str",
+        "help": "Deprecated: Path to the Avrotize schema file (for backcompat)",
+        "required": false
+      }
+    ],
+    "suggested_output_file_path": "{input_file_name}.csv.json",
+    "prompts": []
+  },
   {
     "command": "s2rust",
     "description": "Convert JSON Structure to Rust classes",
@@ -2147,7 +2287,7 @@
     ]
   },
   {
-    "command": "struct2gql",
+    "command": "s2graphql",
     "description": "Convert JSON Structure schema to GraphQL schema",
     "group": "1_Schemas",
     "function": {
@@ -2179,6 +2319,44 @@
     "suggested_output_file_path": "{input_file_name}.graphql",
     "prompts": []
   },
+  {
+    "command": "a2graphql",
+    "description": "Convert Avrotize schema to GraphQL schema",
+    "group": "1_Schemas",
+    "function": {
+      "name": "avrotize.avrotographql.convert_avro_to_graphql",
+      "args": {
+        "avro_schema_path": "input_file_path",
+        "graphql_schema_path": "output_file_path"
+      }
+    },
+    "extensions": [
+      ".avsc"
+    ],
+    "args": [
+      {
+        "name": "input",
+        "type": "str",
+        "nargs": "?",
+        "help": "Path to the Avrotize schema file (or read from stdin if omitted)",
+        "required": false
+      },
+      {
+        "name": "--out",
+        "type": "str",
+        "help": "Path to the GraphQL schema file",
+        "required": false
+      },
+      {
+        "name": "--avsc",
+        "type": "str",
+        "help": "Deprecated: Path to the Avrotize schema file (for backcompat)",
+        "required": false
+      }
+    ],
+    "suggested_output_file_path": "{input_file_name}.graphql",
+    "prompts": []
+  },
   {
     "command": "a2ts",
     "description": "Convert Avrotize schema to TypeScript classes",
@@ -2824,7 +3002,7 @@
     ]
   },
   {
-    "command": "struct2cassandra",
+    "command": "s2cassandra",
     "description": "Convert JSON Structure schema to Cassandra schema",
     "group": "5_SQL",
     "function": {
@@ -3368,7 +3546,7 @@
     "prompts": []
   },
   {
-    "command": "struct2md",
+    "command": "s2md",
     "description": "Convert JSON Structure schema to Markdown documentation",
     "group": "7_Utility",
     "function": {

{avrotize-2.22.2.dist-info → avrotize-3.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: avrotize
-Version: 2.22.2
+Version: 3.0.0
 Summary: Tools to convert from and to Avro Schema from various other schema languages.
 Author-email: Clemens Vasters <clemensv@microsoft.com>
 Requires-Python: >=3.10
@@ -90,13 +90,13 @@ Converting from Avrotize Schema:
 - [`avrotize a2k`](#convert-avrotize-schema-to-kusto-table-declaration) - Convert Avrotize Schema to Kusto table definition.
 - [`avrotize s2k`](#convert-json-structure-schema-to-kusto-table-declaration) - Convert JSON Structure Schema to Kusto table definition.
 - [`avrotize a2sql`](#convert-avrotize-schema-to-sql-table-definition) - Convert Avrotize Schema to SQL table definition.
-- [`avrotize struct2sql`](#convert-json-structure-schema-to-sql-schema) - Convert JSON Structure Schema to SQL table definition.
+- [`avrotize s2sql`](#convert-json-structure-schema-to-sql-schema) - Convert JSON Structure Schema to SQL table definition.
 - [`avrotize a2pq`](#convert-avrotize-schema-to-empty-parquet-file) - Convert Avrotize Schema to Parquet or Iceberg schema.
 - [`avrotize a2ib`](#convert-avrotize-schema-to-iceberg-schema) - Convert Avrotize Schema to Iceberg schema.
 - [`avrotize s2ib`](#convert-json-structure-to-iceberg-schema) - Convert JSON Structure to Iceberg schema.
 - [`avrotize a2mongo`](#convert-avrotize-schema-to-mongodb-schema) - Convert Avrotize Schema to MongoDB schema.
 - [`avrotize a2cassandra`](#convert-avrotize-schema-to-cassandra-schema) - Convert Avrotize Schema to Cassandra schema.
-- [`avrotize struct2cassandra`](#convert-json-structure-schema-to-cassandra-schema) - Convert JSON Structure Schema to Cassandra schema.
+- [`avrotize s2cassandra`](#convert-json-structure-schema-to-cassandra-schema) - Convert JSON Structure Schema to Cassandra schema.
 - [`avrotize a2es`](#convert-avrotize-schema-to-elasticsearch-schema) - Convert Avrotize Schema to Elasticsearch schema.
 - [`avrotize a2dynamodb`](#convert-avrotize-schema-to-dynamodb-schema) - Convert Avrotize Schema to DynamoDB schema.
 - [`avrotize a2cosmos`](#convert-avrotize-schema-to-cosmosdb-schema) - Convert Avrotize Schema to CosmosDB schema.
@@ -106,7 +106,7 @@ Converting from Avrotize Schema:
 - [`avrotize a2neo4j`](#convert-avrotize-schema-to-neo4j-schema) - Convert Avrotize Schema to Neo4j schema.
 - [`avrotize a2dp`](#convert-avrotize-schema-to-datapackage-schema) - Convert Avrotize Schema to Datapackage schema.
 - [`avrotize a2md`](#convert-avrotize-schema-to-markdown-documentation) - Convert Avrotize Schema to Markdown documentation.
-- [`avrotize struct2md`](#convert-json-structure-schema-to-markdown-documentation) - Convert JSON Structure schema to Markdown documentation.
+- [`avrotize s2md`](#convert-json-structure-schema-to-markdown-documentation) - Convert JSON Structure schema to Markdown documentation.
 
 Direct conversions (JSON Structure):
 
@@ -137,7 +137,10 @@ Generate code from JSON Structure:
 Direct JSON Structure conversions:
 
 - [`avrotize s2csv`](#convert-json-structure-to-csv-schema) - Convert JSON Structure schema to CSV schema.
+- [`avrotize a2csv`](#convert-avrotize-schema-to-csv-schema) - Convert Avrotize schema to CSV schema.
 - [`avrotize s2x`](#convert-json-structure-to-xml-schema-xsd) - Convert JSON Structure to XML Schema (XSD).
+- [`avrotize s2graphql`](#convert-json-structure-schema-to-graphql-schema) - Convert JSON Structure schema to GraphQL schema.
+- [`avrotize a2graphql`](#convert-avrotize-schema-to-graphql-schema) - Convert Avrotize schema to GraphQL schema.
 
 Other commands:
 
@@ -147,10 +150,6 @@ JSON Structure conversions:
 
 - [`avrotize s2dp`](#convert-json-structure-schema-to-datapackage-schema) - Convert JSON Structure schema to Datapackage schema.
 
-Direct conversions (not via Avrotize Schema):
-
-- [`avrotize struct2gql`](#convert-json-structure-schema-to-graphql-schema) - Convert JSON Structure schema to GraphQL schema.
-
 ## Overview
 
 You can use Avrotize to convert between Avro/Avrotize Schema and other schema formats like JSON Schema, XML Schema (XSD), Protocol Buffers (Protobuf), ASN.1, and database schema formats like Kusto Data Table Definition (KQL) and SQL Table Definition. That means you can also convert from JSON Schema to Protobuf going via Avrotize Schema.
@@ -489,7 +488,7 @@ For detailed conversion rules and type mappings for each SQL dialect, refer to t
 ### Convert JSON Structure Schema to SQL Schema
 
 ```bash
-avrotize struct2sql [input] --out <path_to_sql_script> --dialect <dialect> [--emit-cloudevents-columns]
+avrotize s2sql [input] --out <path_to_sql_script> --dialect <dialect> [--emit-cloudevents-columns]
 ```
 
 Parameters:
@@ -545,7 +544,7 @@ Refer to the detailed conversion notes for Cassandra in the [NoSQL Conversion No
 ### Convert JSON Structure Schema to Cassandra Schema
 
 ```bash
-avrotize struct2cassandra [input] --out <output_file> [--emit-cloudevents-columns]
+avrotize s2cassandra [input] --out <output_file> [--emit-cloudevents-columns]
 ```
 
 Parameters:
@@ -1153,7 +1152,7 @@ Conversion notes:
 ### Convert JSON Structure schema to Markdown documentation
 
 ```bash
-avrotize struct2md <path_to_structure_schema_file> [--out <path_to_markdown_file>]
+avrotize s2md <path_to_structure_schema_file> [--out <path_to_markdown_file>]
 ```
 
 Parameters:
@@ -1201,6 +1200,25 @@ Conversion notes:
 - Enum and const keywords are supported and preserved in the output.
 - JSON Structure-specific features like `$ref`, `$extends`, definitions, and namespaces are resolved during conversion.
 
+### Convert Avrotize Schema to CSV Schema
+
+```bash
+avrotize a2csv <path_to_avro_schema_file> [--out <path_to_csv_schema_file>]
+```
+
+Parameters:
+
+- `<path_to_avro_schema_file>`: The path to the Avrotize schema file to be converted. If omitted, the file is read from stdin.
+- `--out`: The path to the CSV schema file to write the conversion result to. If omitted, the output is directed to stdout.
+
+Conversion notes:
+
+- The tool converts Avrotize schemas to CSV Schema format.
+- Avro primitive types (string, int, long, float, double, boolean, bytes) are mapped to appropriate CSV schema types.
+- Avro logical types (date, timestamp-millis, decimal, uuid) are preserved in the output.
+- Complex types (records, arrays, maps) are represented as strings in CSV schema, as CSV format doesn't have native support for nested structures.
+- Only single record types can be converted to CSV schema.
+
 ### Convert JSON Structure to Protocol Buffers
 
 ```bash
@@ -1283,7 +1301,7 @@ Conversion notes:
 ### Convert JSON Structure schema to GraphQL schema
 
 ```bash
-avrotize struct2gql [input] --out <path_to_graphql_schema_file>
+avrotize s2graphql [input] --out <path_to_graphql_schema_file>
 ```
 
 Parameters:
@@ -1308,12 +1326,43 @@ Example:
 
 ```bash
 # Convert a JSON Structure schema to GraphQL
-avrotize struct2gql myschema.struct.json --out myschema.graphql
+avrotize s2graphql myschema.struct.json --out myschema.graphql
 
 # Read from stdin and write to stdout
-cat myschema.struct.json | avrotize struct2gql > myschema.graphql
+cat myschema.struct.json | avrotize s2graphql > myschema.graphql
+```
+
+### Convert Avrotize schema to GraphQL schema
+
+```bash
+avrotize a2graphql [input] --out <path_to_graphql_schema_file>
 ```
 
+Parameters:
+
+- `[input]`: The path to the Avrotize schema file. If omitted, the file is read from stdin.
+- `--out <path_to_graphql_schema_file>`: The path to the output GraphQL schema file.
+
+Conversion notes:
+
+- Converts Avrotize schema to GraphQL schema language (SDL)
+- Avro primitive types (string, int, long, float, double, boolean, bytes) are mapped to GraphQL scalar types
+- Avro logical types (date, timestamp-millis, decimal, uuid) are mapped to custom GraphQL scalars
+- Avro record types become GraphQL object types
+- Avro arrays become GraphQL lists `[Type]`
+- Avro maps are represented using the JSON scalar type
+- Avro unions are converted to GraphQL union types
+- Avro enums become GraphQL enum types
+
+Example:
+
+```bash
+# Convert an Avrotize schema to GraphQL
+avrotize a2graphql myschema.avsc --out myschema.graphql
+
+# Read from stdin and write to stdout
+cat myschema.avsc | avrotize a2graphql > myschema.graphql
+```
 
 This document provides an overview of the usage and functionality of Avrotize. For more detailed information, please refer to the [Avrotize Schema documentation](specs/avrotize-schema.md) and the individual command help messages.
 

{avrotize-2.22.2.dist-info → avrotize-3.0.0.dist-info}/RECORD

@@ -1,11 +1,11 @@
 avrotize/__init__.py,sha256=t5h5wkHXr6M0mmHAB5rhjZ3Gxy9xutGTGIfojfao9rI,3820
 avrotize/__main__.py,sha256=5pY8dYAURcOnFRvgb6fgaOIa_SOzPLIWbU8-ZTQ0jG4,88
-avrotize/_version.py,sha256=v1H0R98-rFcU_zocnPjvFocVgN_KV_qdLvPN7LwKIHM,706
+avrotize/_version.py,sha256=9fL11DDeXfhKmxyz_HrYU3Yy7BjMWrJklCddPlmAj6A,704
 avrotize/asn1toavro.py,sha256=QDNwfBfXMxSH-k487CA3CaGCGDzOLs4PpVbbENm5uF0,8386
 avrotize/avrotize.py,sha256=VHFpBltMVBpyt0ju3ZWW725BKjQ4Fk-nrAy8udW-X44,5713
 avrotize/avrotocpp.py,sha256=hRZV247_TDD7Sm6_8sFx-UH5SueLLx2Wg6TvAVUX0iE,25693
 avrotize/avrotocsharp.py,sha256=jOx9ctuUSsdpNDEXnNNfFHOb8zWWHclUvYTF5rInOaM,72339
-avrotize/avrotocsv.py,sha256=PaDEW2aGRFVNLwewWhJ3OwxbKFI3PBg_mTgtT4uLMko,3689
+avrotize/avrotocsv.py,sha256=yqVbP4Ar8bZyEgOAmHuHAsQKfCVjIO5_pa5dtaKLZKE,4575
 avrotize/avrotodatapackage.py,sha256=zSCphLvCYiBKRAUCdccsr-4JysH3PyAS6fSgwa65Tss,7259
 avrotize/avrotodb.py,sha256=5fNJgz00VMimyOl7eI0lIxlcaN_JnN0mb2Q9lzCRecw,46989
 avrotize/avrotogo.py,sha256=H4jxdO7laRWKJuU6mytz2sgUa_20hZUlsBrUGrCe_UU,22405
@@ -25,7 +25,7 @@ avrotize/avrotorust.py,sha256=HEcDirRBCbXQNNs_FmkT-sp1dWQgZ8A23qkQYUxVuXE,24255
 avrotize/avrotots.py,sha256=u_XLjlHN0Gof5QYlpqK4X9WoX9rL30TjQMPg4TiyYnI,33241
 avrotize/avrotoxsd.py,sha256=iGQq_8kC0kfKsqvqS6s_mO-kJ8N5G8vXOwqRI_DZUxc,17744
 avrotize/cddltostructure.py,sha256=MA2c-P3CIEAxEaBX-FF299gR55xcLEV3FrfTr2QfayM,74491
-avrotize/commands.json,sha256=I36P5rEoL8cqcx4P8a_VhXyGsg6NHRPiByQbofYYWj8,93350
+avrotize/commands.json,sha256=3N1Jblh-_o2GRbhcrMXLUEf0pijsYu6ff-nAbT5nhTE,98316
 avrotize/common.py,sha256=enqNR1I9-SbW7fNJE3w7N2R87kiN6_9Oa7VB4b2AUBc,31913
 avrotize/constants.py,sha256=LlgHrvT6RsRPrhFGRNHmFuIj3b1bSd45yC4rBCIGGVA,2753
 avrotize/csvtoavro.py,sha256=TuIYm_Xv8gioEHl1YgWQKOYkFGGHfuwmK5RuEAEXbt8,4293
@@ -164,8 +164,8 @@ avrotize/structuretots/index.ts.jinja,sha256=-R4R_En1N4W_BEN3z3bLts9Xi4KnBTDLrYM
 avrotize/structuretots/package.json.jinja,sha256=OfJn4g68VhBP-yvJCdsWm_1RHx1kphsmdWpxu_Fst1E,819
 avrotize/structuretots/test_class.ts.jinja,sha256=7tJ6hPo3A9zToTkwolVyXYhmZ_E4uI_OnnYsUUzUEdQ,1180
 avrotize/structuretots/tsconfig.json.jinja,sha256=8Pl65JW8uOMEexxkteobo0ZEqsJBO31HegNRUrf8XGQ,515
-avrotize-2.22.2.dist-info/entry_points.txt,sha256=m8J2TWiqbZh7SBQezc1CNrM_GVPWf01zOFcAKhzCC0U,51
-avrotize-2.22.2.dist-info/licenses/LICENSE,sha256=xGtQGygTETTtDQJafZCUbpsed3GxO6grmqig-jGEuSk,11348
-avrotize-2.22.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-avrotize-2.22.2.dist-info/METADATA,sha256=0jsbD4l1SqZx4NZsh1lKartOUGfdm06mj9o_C-YaFqQ,80208
-avrotize-2.22.2.dist-info/RECORD,,
+avrotize-3.0.0.dist-info/entry_points.txt,sha256=m8J2TWiqbZh7SBQezc1CNrM_GVPWf01zOFcAKhzCC0U,51
+avrotize-3.0.0.dist-info/licenses/LICENSE,sha256=xGtQGygTETTtDQJafZCUbpsed3GxO6grmqig-jGEuSk,11348
+avrotize-3.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+avrotize-3.0.0.dist-info/METADATA,sha256=08ps9dsDdgQiglCf7idjcYMovejdlViYENVZf0Xtqc8,82284
+avrotize-3.0.0.dist-info/RECORD,,