[wip] Jw/snow 1769565 add stage entity model #2027
Conversation
| @app.command("createv2", requires_connection=True) | ||
| def stage_createv2(stage_name: FQN = StageNameArgument, **options) -> dict: | ||
| """ | ||
| needed only for testing purposes | ||
| """ | ||
| stage = StageEntity.create(stage_name.name) | ||
| return stage.to_dict() |
There was a problem hiding this comment.
returning a dict is not supported, but that's what was printed by stage.to_dict()
hatch run snow stage createv2 jwilkowski_test2
{'created_on': datetime.datetime(2025, 1, 27, 14, 13, 24, 718000, tzinfo=TzInfo(UTC)),
'directory_table': {'auto_refresh': False,
'enable': False,
'refresh_on_create': True},
'has_credentials': False,
'has_encryption_key': False,
'kind': 'PERMANENT',
'name': 'JWILKOWSKI_TEST2',
'owner': 'ACCOUNTADMIN',
'owner_role_type': 'ROLE',
'type': 'stage',
'url': ''}
Stage gets created on integration env:
There was a problem hiding this comment.
Commands shout return CommandOutput subclass - check them in src/snowflake/cli/api/output/types.py
Currently stage create returns snowflake cursor with serverside-resposne
There was a problem hiding this comment.
StageCollection.create returns return StageResource(stage.name, self)- so just a MessageResult with stage.name should be ok
| @app.command("createv2", requires_connection=True) | ||
| def stage_createv2(stage_name: FQN = StageNameArgument, **options) -> dict: | ||
| """ | ||
| needed only for testing purposes | ||
| """ | ||
| stage = StageEntity.create(stage_name.name) | ||
| return stage.to_dict() |
There was a problem hiding this comment.
Commands shout return CommandOutput subclass - check them in src/snowflake/cli/api/output/types.py
Currently stage create returns snowflake cursor with serverside-resposne
| type: Literal["stage"] = DiscriminatorField() # noqa: A003 | ||
| # TODO: discuss: inherit or compose? composition would require either a lot of magic or double keying of fields, | ||
| # while inheritance does that for free + offers autocompletion etc | ||
| # api_resource: Stage |
There was a problem hiding this comment.
I would go this way. So the model class will inherit only from EntityModelBase and use a field of type Stage with methods wrapping around it
There was a problem hiding this comment.
Ok, I'll give it a try
| @staticmethod | ||
| def get_root() -> Root: | ||
| conn: SnowflakeConnection = get_cli_context().connection | ||
| return Root(conn) |
There was a problem hiding this comment.
No need for this, after merge of #2014 EntityBase has snow_api_root property, that returns just that
There was a problem hiding this comment.
Sure, that's why I extracted that method for easier refactor once it's available upstream :)
| entity_model_cls = cls.get_entity_model_type() | ||
| temp = stage_resource.fetch() | ||
|
|
||
| entity_model = entity_model_cls(type="stage", **temp.to_dict()) |
There was a problem hiding this comment.
I don't think we need adding discriminator field here. Also, we can call StageEntityModel directly- get_entity_model_type is rathe meant for use in situations, when we have many entities of different types
| @@ -272,3 +273,12 @@ def _put( | |||
| auto_compress=auto_compress, | |||
| ) | |||
| return QueryResult(cursor) | |||
|
|
|||
|
|
|||
| @app.command("createv2", requires_connection=True) | |||
There was a problem hiding this comment.
Just to be safe for now, lets add hidden=True here
There was a problem hiding this comment.
I did not intend to ship it in the final version, I just wanted to have some command for end to end testing. Is it expected to expose new commands? That would collide with existing ones
There was a problem hiding this comment.
Yes, but this will hide the command from any help messages, so the tests will pass
| conn: SnowflakeConnection = get_cli_context().connection | ||
| if root is None: | ||
| root = cls.get_root() | ||
| return root.databases[conn.database].schemas[conn.schema].stages |
There was a problem hiding this comment.
It doesn't have to be conn.database/schema - we should derive it from FQN if possible
|
|
||
| # TODO: discuss: this code looks mostly generic so might go as well to the mixin class. Don't do it too fast to | ||
| # avoid issues of premature abstraction | ||
| @classmethod |
There was a problem hiding this comment.
Maybe we could make it an instance method- so it would instantiate a model, as user defines a stage in the project, and then we would use instance method to create said stage server-side. WDYT?
| @app.command("createv2", requires_connection=True) | ||
| def stage_createv2(stage_name: FQN = StageNameArgument, **options) -> dict: | ||
| """ | ||
| needed only for testing purposes | ||
| """ | ||
| stage = StageEntity.create(stage_name.name) | ||
| return stage.to_dict() |
There was a problem hiding this comment.
StageCollection.create returns return StageResource(stage.name, self)- so just a MessageResult with stage.name should be ok
Pre-review checklist
Changes description
https://snowflakecomputing.atlassian.net/browse/SNOW-1769565