|
8 | 8 | parent_qualified_name: str,
|
9 | 9 | parent_type: type,
|
10 | 10 | order: int,
|
11 |
| - ) -> Column: ... |
| 11 | + ) -> Column: |
| 12 | + """ |
| 13 | + Builds the minimal object necessary to create a Column. |
| 14 | + |
| 15 | + :param name: name of the Column |
| 16 | + :param parent_qualified_name: unique name of the table / view / materialized view |
| 17 | + / table partition / snowflake dynamic table in which this Column exists |
| 18 | + :param parent_type: type of parent (table, view, materialized view, |
| 19 | + table partition, snowflake dynamic table), should be a TYPE_NAME static string |
| 20 | + :param order: the order the Column appears within its parent (the Column's position) |
| 21 | + :returns: the minimal request necessary to create the Column |
| 22 | + """ |
12 | 23 |
|
13 | 24 | @overload
|
14 | 25 | @classmethod
|
|
27 | 38 | table_name: str,
|
28 | 39 | table_qualified_name: str,
|
29 | 40 | connection_qualified_name: str,
|
30 |
| - ) -> Column: ... |
| 41 | + ) -> Column: |
| 42 | + """ |
| 43 | + Builds the minimal object necessary to create a Column. |
| 44 | + |
| 45 | + :param name: name of the Column |
| 46 | + :param parent_qualified_name: unique name of the table / view / materialized view |
| 47 | + / table partition / snowflake dynamic table in which this Column exist |
| 48 | + :param parent_type: type of parent (table, view, materialized view, |
| 49 | + table partition, snowflake dynamic table), should be a TYPE_NAME static string |
| 50 | + :param order: the order the Column appears within its parent (the Column's position) |
| 51 | + :param parent_name: simple name of the table / view / materialized view / table partition |
| 52 | + / snowflake dynamic table in which the Column should be created |
| 53 | + :param database_name: simple name of the database in which the Column should be created |
| 54 | + :param database_qualified_name: unique name of the database in which the Column should be created |
| 55 | + :param schema_name: simple name of the schema in which the Column should be created |
| 56 | + :param schema_qualified_name: unique name of the schema in which the Column should be created |
| 57 | + :param table_name: (deprecated - unused) |
| 58 | + :param table_qualified_name: (deprecated - unused) |
| 59 | + :param connection_qualified_name: unique name of the connection in which the Column should be created |
| 60 | + :returns: the minimal request necessary to create the Column |
| 61 | + """ |
31 | 62 |
|
32 | 63 | @classmethod
|
33 | 64 | @init_guid
|
|
47 | 78 | table_qualified_name: Optional[str] = None,
|
48 | 79 | connection_qualified_name: Optional[str] = None,
|
49 | 80 | ) -> Column:
|
| 81 | + """ |
| 82 | + Builds the minimal object necessary to create a Column. |
| 83 | + |
| 84 | + :param name: name of the Column |
| 85 | + :param parent_qualified_name: unique name of the table / view / materialized view |
| 86 | + / table partition / snowflake dynamic table in which this Column exists |
| 87 | + :param parent_type: type of parent (table, view, materialized view, |
| 88 | + table partition, snowflake dynamic table), should be a TYPE_NAME static string |
| 89 | + :param order: the order the Column appears within its parent (the Column's position) |
| 90 | + :param parent_name: simple name of the table / view / materialized view / table partition |
| 91 | + / snowflake dynamic table in which the Column should be created |
| 92 | + :param database_name: simple name of the database in which the Column should be created |
| 93 | + :param database_qualified_name: unique name of the database in which the Column should be created |
| 94 | + :param schema_name: simple name of the schema in which the Column should be created |
| 95 | + :param schema_qualified_name: unique name of the schema in which the Column should be created |
| 96 | + :param table_name: (deprecated - unused) |
| 97 | + :param table_qualified_name: (deprecated - unused) |
| 98 | + :param connection_qualified_name: unique name of the connection in which the Column should be created |
| 99 | + :returns: the minimal request necessary to create the Column |
| 100 | + """ |
| 101 | + if table_name: |
| 102 | + warn( |
| 103 | + ("`table_name` is deprecated, please use `parent_name` instead"), |
| 104 | + DeprecationWarning, |
| 105 | + stacklevel=2, |
| 106 | + ) |
| 107 | + if table_qualified_name: |
| 108 | + warn( |
| 109 | + ( |
| 110 | + "`table_qualified_name` is deprecated, please use `parent_qualified_name` instead" |
| 111 | + ), |
| 112 | + DeprecationWarning, |
| 113 | + stacklevel=2, |
| 114 | + ) |
50 | 115 | return Column(
|
51 | 116 | attributes=Column.Attributes.create(
|
52 | 117 | name=name,
|
|
0 commit comments