-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor TableSession and TableSessionPool of Python client (#14232)
* refector py table session * refector py table session * fix python 3.6 * fix IY * fix table session * Fix CI * fix IT * fix IT * fix IT * builder * fix example * tableSession python
- Loading branch information
Showing
27 changed files
with
384 additions
and
136 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
# | ||
from typing import Union | ||
|
||
from iotdb.Session import Session | ||
from iotdb.utils.NumpyTablet import NumpyTablet | ||
from iotdb.utils.SessionDataSet import SessionDataSet | ||
from iotdb.utils.Tablet import Tablet | ||
|
||
|
||
class TableSessionConfig(object): | ||
|
||
def __init__( | ||
self, | ||
node_urls: list = None, | ||
username: str = Session.DEFAULT_USER, | ||
password: str = Session.DEFAULT_PASSWORD, | ||
database: str = None, | ||
fetch_size: int = 5000, | ||
time_zone: str = Session.DEFAULT_ZONE_ID, | ||
enable_redirection: bool = True, | ||
enable_compression: bool = False, | ||
): | ||
""" | ||
Initialize a TableSessionConfig object with the provided parameters. | ||
Parameters: | ||
node_urls (list, optional): A list of node URLs for the database connection. | ||
Defaults to ["localhost:6667"]. | ||
username (str, optional): The username for the database connection. | ||
Defaults to "root". | ||
password (str, optional): The password for the database connection. | ||
Defaults to "root". | ||
database (str, optional): The target database to connect to. Defaults to None. | ||
fetch_size (int, optional): The number of rows to fetch per query. Defaults to 5000. | ||
time_zone (str, optional): The default time zone for the session. | ||
Defaults to Session.DEFAULT_ZONE_ID. | ||
enable_redirection (bool, optional): Whether to enable redirection. | ||
Defaults to False. | ||
enable_compression (bool, optional): Whether to enable data compression. | ||
Defaults to False. | ||
""" | ||
if node_urls is None: | ||
node_urls = ["localhost:6667"] | ||
self.node_urls = node_urls | ||
self.username = username | ||
self.password = password | ||
self.database = database | ||
self.fetch_size = fetch_size | ||
self.time_zone = time_zone | ||
self.enable_redirection = enable_redirection | ||
self.enable_compression = enable_compression | ||
|
||
|
||
class TableSession(object): | ||
|
||
def __init__( | ||
self, table_session_config: TableSessionConfig = None, session_pool=None | ||
): | ||
self.__session_pool = session_pool | ||
if self.__session_pool is None: | ||
self.__session = Session.init_from_node_urls( | ||
table_session_config.node_urls, | ||
table_session_config.username, | ||
table_session_config.password, | ||
table_session_config.fetch_size, | ||
table_session_config.time_zone, | ||
table_session_config.enable_redirection, | ||
) | ||
self.__session.sql_dialect = "table" | ||
self.__session.database = table_session_config.database | ||
self.__session.open(table_session_config.enable_compression) | ||
else: | ||
self.__session = self.__session_pool.get_session() | ||
|
||
def insert(self, tablet: Union[Tablet, NumpyTablet]): | ||
""" | ||
Insert data into the database. | ||
Parameters: | ||
tablet (Tablet | NumpyTablet): The tablet containing the data to be inserted. | ||
Accepts either a `Tablet` or `NumpyTablet`. | ||
Raises: | ||
IoTDBConnectionException: If there is an issue with the database connection. | ||
""" | ||
self.__session.insert_relational_tablet(tablet) | ||
|
||
def execute_non_query_statement(self, sql: str): | ||
""" | ||
Execute a non-query SQL statement. | ||
Parameters: | ||
sql (str): The SQL statement to execute. Typically used for commands | ||
such as INSERT, DELETE, or UPDATE. | ||
Raises: | ||
IoTDBConnectionException: If there is an issue with the database connection. | ||
""" | ||
self.__session.execute_non_query_statement(sql) | ||
|
||
def execute_query_statement( | ||
self, sql: str, timeout_in_ms: int = 0 | ||
) -> SessionDataSet: | ||
""" | ||
Execute a query SQL statement and return the result set. | ||
Parameters: | ||
sql (str): The SQL query to execute. | ||
timeout_in_ms (int, optional): Timeout for the query in milliseconds. Defaults to 0, | ||
which means no timeout. | ||
Returns: | ||
SessionDataSet: The result set of the query. | ||
Raises: | ||
IoTDBConnectionException: If there is an issue with the database connection. | ||
""" | ||
return self.__session.execute_query_statement(sql, timeout_in_ms) | ||
|
||
def close(self): | ||
""" | ||
Close the session and release resources. | ||
Raises: | ||
IoTDBConnectionException: If there is an issue closing the connection. | ||
""" | ||
if self.__session_pool is None: | ||
self.__session.close() | ||
else: | ||
self.__session_pool.put_back(self.__session) |
Oops, something went wrong.