MS SQL Server: Customise auto-generated field names¶

You can customize auto-generated field names in the tables.yaml file inside the metadata directory:

 - table:
     schema: dbo
     name: author
   configuration:
     custom_column_names:
       addr: address

Apply the metadata by running:

hasura metadata apply

A custom field name can be set for a column via the following 2 methods:

1. Passing a Table Config with the CustomColumnNames to the mssql_set_table_customization API while tracking a table:

   POST /v1/metadata HTTP/1.1
   Content-Type: application/json
   X-Hasura-Role: admin
   
   {
     "type": "mssql_set_table_customization",
     "args": {
       "table": "authors",
       "configuration": {
         "custom_column_names": {
           "id": "AuthorId"
         }
       }
     }
   }
   

2. Customization can be done at the time of creation using mssql_track_table API also.

You can expose table root fields with a different name in the GraphQL API in the tables.yaml file inside the metadata directory:

 - table:
     schema: dbo
     name: authors
   configuration:
     custom_root_fields:
       select: authors_aggregate

After that, apply the metadata by running:

hasura metadata apply

A custom field name can be set for a table root field via the following 2 methods:

1. Passing a Table Config with the Custom Root Fields to the mssql_set_table_customization API while tracking a table:

   POST /v1/metadata HTTP/1.1
   Content-Type: application/json
   X-Hasura-Role: admin
   
   {
     "type": "mssql_set_table_customization",
     "args": {
       "table": "authors",
       "configuration": {
         "custom_column_names": {
           "id": "AuthorId"
         }
         "custom_root_fields": {
           "select": "authors",
           "select_aggregate": "authors_aggregate"
         }
       }
     }
   }
   

2. Customization can be done at the time of creation using mssql_track_table API also.