From d4e0ceaa8d1c5606ada1519228a463ea2b4cfb0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=94=98=E9=9C=96?= Date: Tue, 29 Oct 2024 17:24:51 +0800 Subject: [PATCH] PullRequest: 25 feat: add param of import script from init and create tenant MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Merge branch import_script of git@code.alipay.com:oceanbase/OBShell-SDK-Python.git into master https://code.alipay.com/oceanbase/OBShell-SDK-Python/pull_requests/25?tab=comment Signed-off-by: 玉楼 * feat: add param of import script from init and create tenant * chore: optz the comment for import_script --- obshell/service/client_v1.py | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/obshell/service/client_v1.py b/obshell/service/client_v1.py index 774cad7..2d52243 100644 --- a/obshell/service/client_v1.py +++ b/obshell/service/client_v1.py @@ -364,23 +364,29 @@ def config_obcluster_sync(self, self._set_password_candidate_auth(root_pwd) return self.wait_dag_succeed(dag.generic_id) - def init(self) -> task.DagDetailDTO: + def init(self, import_script=False) -> task.DagDetailDTO: """Initializes the cluster. Return as soon as request successfully. You can use wait_dag_succeed to wait for the init task to succeed or use init_sync to initialize synchronously instead. + Args: + import_script (bool, optional): + Whether need to import the observer's script. Defaults to False. + Support from OBShell V4.2.4.2. + Returns: Task detail as task.DagDetailDTO. Raises: OBShellHandleError: error message return by OBShell server. """ - req = self.create_request("/api/v1/ob/init", "POST") + req = self.create_request( + "/api/v1/ob/init", "POST", data={"import_script": import_script}) return self.__handle_task_ret_request(req) - def init_sync(self) -> task.DagDetailDTO: + def init_sync(self, import_script=False) -> task.DagDetailDTO: """Initializes the cluster synchronously. Seealso init. @@ -391,7 +397,7 @@ def init_sync(self) -> task.DagDetailDTO: TaskExecuteFailedError: raise when the task failed, include the failed task detail and logs. """ - dag = self.init() + dag = self.init(import_script) return self.wait_dag_succeed(dag.generic_id) def start(self, level: str, target: list, force_pass_dag=None) -> task.DagDetailDTO: @@ -1023,7 +1029,8 @@ def get_resource_unit_config(self, unit_config_name: str) -> unit.UnitConfig: def create_tenant( self, tenant_name: str, zone_list: List[tenant.ZoneParam], mode: str = 'MYSQL', primary_zone: str = None, whitelist: str = None, - root_password: str = None, scenario: str = None, charset: str = None, collation: str = None, read_only: bool = False, + root_password: str = None, scenario: str = None, import_script: bool = False, + charset: str = None, collation: str = None, read_only: bool = False, comment: str = None, variables: dict = None, parameters: dict = None) -> task.DagDetailDTO: """Creates a tenant. @@ -1042,7 +1049,8 @@ def create_tenant( "zone_list": [zone.__dict__ for zone in zone_list], } options = ['mode', 'primary_zone', 'whitelist', 'root_password', 'charset', - 'collation', 'read_only', 'comment', 'variables', 'parameters', 'scenario'] + "import_script", 'collation', 'read_only', 'comment', 'variables', + 'parameters', 'scenario'] mydict = locals() for k, v in mydict.items(): if k in options and v is not None: @@ -1052,8 +1060,8 @@ def create_tenant( def create_tenant_sync( self, tenant_name: str, zone_list: List[tenant.ZoneParam], mode: str = 'MYSQL', - primary_zone: str = "RANDOM", whitelist: str = None, root_password: str = None, - scenario: str = None, + primary_zone: str = "RANDOM", whitelist: str = None, + root_password: str = None, scenario: str = None, import_script: bool = False, charset: str = None, collation: str = None, read_only: bool = False, comment: str = None, variables: dict = None, parameters: dict = None) -> task.DagDetailDTO: """Create a tenant synchronously. @@ -1076,6 +1084,9 @@ def create_tenant_sync( Defaults to 'oltp'. root_password (str, optional): The root password of the tenant. Defaults to Empty. + import_script (bool, optional): + Whether need to import the observer's script. Defaults to False. + Support from OBShell V4.2.4.2. charset (str, optional): The charset of the tenant. If not set, the charset will be set to default value by observer. collation (str, optional): The collation of the tenant. @@ -1095,7 +1106,8 @@ def create_tenant_sync( include the failed task detail and logs. """ dag = self.create_tenant( - tenant_name, zone_list, mode, primary_zone, whitelist, root_password, scenario, charset, collation, read_only, comment, variables, parameters) + tenant_name, zone_list, mode, primary_zone, whitelist, root_password, + scenario, import_script, charset, collation, read_only, comment, variables, parameters) return self.wait_dag_succeed(dag.generic_id) def drop_tenant(self, tenant_name: str, need_recycle: bool = False) -> task.DagDetailDTO: