a bgY@sdZddlmZddlmZmZmZmZmZm Z m Z m Z ddl Z ddl mZddlmZddl mZmZmZmZmZmZddlmZmZmZdd lmZmZdd lmZdd l m!Z!dd l"m#Z#d ddddZ$dddddddddZ%GdddZ&dS)%SQLAlchemy wrapper around a database.) annotations)AnyDictIterableListLiteralOptionalSequenceUnionN) deprecated) get_from_env)MetaDataTable create_engineinspectselecttext)URLEngineResult)ProgrammingErrorSQLAlchemyError) CreateTable) Executable)NullTypez+sqlalchemy.engine.interfaces.ReflectedIndexstr)indexreturncCs&d|dd|ddt|dS)NzName: namez , Unique: uniquez , Columns: Z column_namesr)rr"x/var/www/html/cobodadashboardai.evdpl.com/venv/lib/python3.9/site-packages/langchain_community/utilities/sql_database.py _format_indexs r$z...)suffixrint)contentlengthr%rcCsJt|tr|dkr|St||kr&|S|d|t|ddd|S)z] Truncate a string to a certain number of words, based on the max string length. rN ) isinstancerlenrsplit)r'r(r%r"r"r# truncate_word s  r.c @seZdZdZdMdddd d d d d d d d d ddZedNdd dddddZedOddddddd ddd ddZedPddddddddd Ze dd!d"d#Z d$d!d%d&Z e d'd(d)d*d$d!d+d,Z e dd!d-d.ZdQd dd/d0d1Zd2dd3d4d5Zd2dd3d6d7ZdRddd9d:d;dd?d@ZdSddd9d:d;d dosz'SQLDatabase.__init__..Zviewsbindonlyr4N)_engine_schema ValueErrorr _inspectorsetlistget_table_namesZget_view_names _all_tables_include_tables_ignore_tablesget_usable_table_namesZ_usable_tablesr+r& TypeError_sample_rows_in_table_info_indexes_in_table_infor?dictrC_max_string_length _view_supportr _metadatareflect)rDr3r4r5r6r7r8r9r:r;r<r=missing_tablesZ usable_tablesr"rBr#__init__2sd       zSQLDatabase.__init__zUnion[str, URL]r) database_uri engine_argskwargsrcKs$|pi}|t|fi|fi|S)z'Construct a SQLAlchemy engine from URI.)r)clsr^r_r`Z _engine_argsr"r"r#from_uriszSQLDatabase.from_urir) catalogr4host api_token warehouse_id cluster_idr_r`rc Ks$zddlm} Wnty*tdYn0d} zddlm} | } | j} Wnttfyfd} Yn0|dur|tdd| }| r| jnd} |durtdd | }|dur|dur| r| j }nt d |r|rt d |rd |}n d |}d|d|d|d|d| }|j f||d|S)a Class method to create an SQLDatabase instance from a Databricks connection. This method requires the 'databricks-sql-connector' package. If not installed, it can be added using `pip install databricks-sql-connector`. Args: catalog (str): The catalog name in the Databricks database. schema (str): The schema name in the catalog. host (Optional[str]): The Databricks workspace hostname, excluding 'https://' part. If not provided, it attempts to fetch from the environment variable 'DATABRICKS_HOST'. If still unavailable and if running in a Databricks notebook, it defaults to the current workspace hostname. Defaults to None. api_token (Optional[str]): The Databricks personal access token for accessing the Databricks SQL warehouse or the cluster. If not provided, it attempts to fetch from 'DATABRICKS_TOKEN'. If still unavailable and running in a Databricks notebook, a temporary token for the current user is generated. Defaults to None. warehouse_id (Optional[str]): The warehouse ID in the Databricks SQL. If provided, the method configures the connection to use this warehouse. Cannot be used with 'cluster_id'. Defaults to None. cluster_id (Optional[str]): The cluster ID in the Databricks Runtime. If provided, the method configures the connection to use this cluster. Cannot be used with 'warehouse_id'. If running in a Databricks notebook and both 'warehouse_id' and 'cluster_id' are None, it uses the ID of the cluster the notebook is attached to. Defaults to None. engine_args (Optional[dict]): The arguments to be used when connecting Databricks. Defaults to None. **kwargs (Any): Additional keyword arguments for the `from_uri` method. Returns: SQLDatabase: An instance of SQLDatabase configured with the provided Databricks connection details. Raises: ValueError: If 'databricks-sql-connector' is not found, or if both 'warehouse_id' and 'cluster_id' are provided, or if neither 'warehouse_id' nor 'cluster_id' are provided and it's not executing inside a Databricks notebook. r)sqlzfdatabricks-sql-connector package not found, please install with `pip install databricks-sql-connector`N) get_contextrdZDATABRICKS_HOSTreZDATABRICKS_TOKENz6Need to provide either 'warehouse_id' or 'cluster_id'.z/Can't have both 'warehouse_id' or 'cluster_id'.z/sql/1.0/warehouses/z/sql/protocolv1/o/0/zdatabricks://token:@z ?http_path=z &catalog=z&schema=)r^r_) Z databricksrh ImportErrorZ!dbruntime.databricks_repl_contextriZbrowserHostNameAttributeErrorr ZapiTokenZ clusterIdrKrb)rarcr4rdrerfrgr_r`rhcontextriZ default_hostZdefault_api_tokenZ http_pathurir"r"r#from_databrickssL4         zSQLDatabase.from_databricks127.0.0.1:8902rootcnosdbpublic)urluserpasswordtenantdatabasercCsJz*ddlm}||||||}|j|dWStyDtdYn0dS)a Class method to create an SQLDatabase instance from a CnosDB connection. This method requires the 'cnos-connector' package. If not installed, it can be added using `pip install cnos-connector`. Args: url (str): The HTTP connection host name and port number of the CnosDB service, excluding "http://" or "https://", with a default value of "127.0.0.1:8902". user (str): The username used to connect to the CnosDB service, with a default value of "root". password (str): The password of the user connecting to the CnosDB service, with a default value of "". tenant (str): The name of the tenant used to connect to the CnosDB service, with a default value of "cnosdb". database (str): The name of the database in the CnosDB tenant. Returns: SQLDatabase: An instance of SQLDatabase configured with the provided CnosDB connection details. r)make_cnosdb_langchain_uri)r^zRcnos-connector package not found, please install with `pip install cnos-connector`N)Zcnosdb_connectorrzrbrk)rarurvrwrxryrzrnr"r"r# from_cnosdbs  zSQLDatabase.from_cnosdb)rcCs |jjjS)z/Return string representation of dialect to use.)rIdialectrrDr"r"r#r|szSQLDatabase.dialectz Iterable[str]cCs |jrt|jSt|j|jSzGet names of tables available.)rQsortedrPrRr}r"r"r#rSs z"SQLDatabase.get_usable_table_namesz0.0.1rSz1.0) alternativeZremovalcCs|Sr~)rSr}r"r"r#rO"szSQLDatabase.get_table_namescCs|S)z-Information about all tables in the database.)get_table_infor}r"r"r# table_info'szSQLDatabase.table_info) table_namesrcs|dur6t|}|r2td|d|ddjjD}tt|}|rzjjjjt |j dfddjjD}g}|D]}j r|j j vr| j |j q|jD]"\}} t| jtur|j| qtt|j} | } jpj} | r,| d7} jrJ| d |d 7} jrh| d |d 7} | rv| d 7} | | q|d |} | S) fGet information about specified tables. Follows best practices as specified in: Rajkumar et al, 2022 (https://arxiv.org/abs/2204.00498) If `sample_rows_in_table_info`, the specified number of sample rows will be appended to each table description. This can increase performance as demonstrated in the paper. Nz table_names r>cSsg|] }|jqSr"rr@tblr"r"r# =z.SQLDatabase.get_table_info..rFcs4g|],}|jtvrjdkr,|jds|qS)ZsqliteZsqlite_)rrMr| startswithrZall_table_namesrDr"r#rGsz /* z*/z )rSrM differencerKrZZ sorted_tablesr[rYrIrNrJr?rappendcolumnsitemstyperZ_columnsremoverrcompilerstriprVrU_get_table_indexes_get_sample_rowssortjoin)rDrr\Zmetadata_table_namesZ to_reflectZ meta_tablesZtablesrAkvZ create_tablerZhas_extra_infoZ final_strr"rr#r,sT      zSQLDatabase.get_table_infor)rArcCs(|j|j}dtt|}d|S)NrzTable Indexes: )rLZ get_indexesrrmapr$)rDrAZindexesZindexes_formattedr"r"r#rlszSQLDatabase._get_table_indexescCst||j}ddd|jD}z^|j,}||}tt dd|}Wdn1sd0Yddd|D}Wnt yd}Yn0|jd |j d |d|S) N cSsg|] }|jqSr"r)r@colr"r"r#rvrz0SQLDatabase._get_sample_rows..cSsdd|DS)NcSsg|]}t|ddqS)Ndr!)r@ir"r"r#r~rzBSQLDatabase._get_sample_rows....r")Zlsr"r"r#~rz.SQLDatabase._get_sample_rows..rcSsg|]}d|qS)r)rr@rowr"r"r#rrrrz rows from z table: ) rlimitrUrrrIconnectexecuterNrrr)rDrAcommandZ columns_str connectionZsample_rows_resultZ sample_rowsZsample_rows_strr"r"r#rqs"   "  zSQLDatabase._get_sample_rowsall parametersexecution_optionszUnion[str, Executable]zLiteral['all', 'one', 'cursor']zOptional[Dict[str, Any]]z'Union[Sequence[Dict[str, Any]], Result])rfetchrrrc Cs|pi}|pi}|j}|jdur|jdkrJ|jd|jf|dn|jdkrj|jd|jf|dn|jdkrvn|jdkr|jd |jf|dnp|jd kr|jd |j|dnN|jd kr|jd |j|dn,|jdkrn |jdkr|jd|jf|dt|trt|}n t|tr*nt dt ||j |||d}|j r|dkrrdd| D}nP|dkr|}|durgn|g}n$|dkr|WdStd|WdSWdn1s0YgS)z Executes SQL command through underlying engine. If the statement returns no rows, an empty list is returned. N snowflakez"ALTER SESSION SET search_path = %s)rZbigqueryzSET @@dataset_id=?ZmssqlZtrinozUSE ?ZduckdbzSET search_path TO oraclez#ALTER SESSION SET CURRENT_SCHEMA = Zsqlany postgresqlzSET search_path TO %sz#Query expression has unknown type: rcSsg|] }|qSr")_asdict)r@xr"r"r#rrz(SQLDatabase._execute..onecursorz8Fetch parameter must be either 'one', 'all', or 'cursor')rIbeginrJr|Zexec_driver_sqlr+rrrrTrrZ returns_rowsZfetchallZfetchonerrK) rDrrrrrrresultZ first_resultr"r"r#_executes                  2zSQLDatabase._executez1Union[str, Sequence[Dict[str, Any]], Result[Any]])rrinclude_columnsrrrcsVj||||d}|dkr|Sfdd|D}|sBdd|D}|sJdSt|SdS)zExecute a SQL command and return a string representing the results. If the statement returns rows, a string of the results is returned. If the statement returns no rows, an empty string is returned. rrcs"g|]}fdd|DqS)cs i|]\}}|t|jdqS))r()r.rX)r@columnvaluer}r"r# sz.SQLDatabase.run...)r)r@rr}r"r#rs z#SQLDatabase.run..cSsg|]}t|qSr")tuplevaluesrr"r"r#rrrrN)rr)rDrrrrrrresr"r}r#runs zSQLDatabase.runc Cs@z ||WSty:}zd|WYd}~Sd}~00dS)rError: N)rrK)rDrer"r"r#get_table_info_no_throw s  z#SQLDatabase.get_table_info_no_throwzLiteral['all', 'one']c CsJz|j|||||dWStyD}zd|WYd}~Sd}~00dS)a*Execute a SQL command and return a string representing the results. If the statement returns rows, a string of the results is returned. If the statement returns no rows, an empty string is returned. If the statement throws an error, the error message is returned. )rrrrN)rr)rDrrrrrrr"r"r# run_no_throwszSQLDatabase.run_no_throwzDict[str, Any]cCs$t|}|}|d|dS)z4Return db context that you may want in agent prompt.z, )rr)rNrSrr)rDrrr"r"r#ri9s zSQLDatabase.get_context) NNNNr0FNFr1F)N)NNNNN)rprqrrrsrt)N)r)rF)N)rF)__name__ __module__ __qualname____doc__r] classmethodrbror{propertyr|rSr rOrrrrrrrrrir"r"r"r#r//st$P "`( @!\%r/)'r __future__rtypingrrrrrr r r Z sqlalchemyZlangchain_core._apir Zlangchain_core.utilsr rrrrrrZsqlalchemy.enginerrrZsqlalchemy.excrrZsqlalchemy.schemarZsqlalchemy.sql.expressionrZsqlalchemy.typesrr$r.r/r"r"r"r#s (