7|hZdZddlmZddlmZmZmZmZmZm Z m Z m Z ddl Z ddl mZddlmZddl mZmZmZmZmZmZddlmZmZmZdd lmZmZdd lmZdd l m!Z!dd l"m#Z#dd Z$ddddZ%GddZ&y)%SQLAlchemy wrapper around a database.) annotations)AnyDictIterableListLiteralOptionalSequenceUnionN) deprecated) get_from_env)MetaDataTable create_engineinspectselecttext)URLEngineResult)ProgrammingErrorSQLAlchemyError) CreateTable) Executable)NullTypec <d|dd|ddt|dS)NzName: namez , Unique: uniquez , Columns: column_namesstr)indexs i/var/www/html/test/engine/venv/lib/python3.12/site-packages/langchain_community/utilities/sql_database.py _format_indexr%s7 vz%/):;~./0 2z...)suffixct|tr|dkr|St||kr|S|d|t|z jddd|zS)z] Truncate a string to a certain number of words, based on the max string length. rN ) isinstancer"lenrsplit)contentlengthr's r$ truncate_wordr0 sX gs #v{ 7|v )Vc&k) * 1 1#q 9! z'SQLDatabase.__init__..os1+L(//67+s"viewsbindonlyr4N)_engine_schema ValueErrorr _inspectorsetlistget_table_namesget_view_names _all_tables_include_tables_ignore_tablesget_usable_table_names_usable_tablesr+int TypeError_sample_rows_in_table_info_indexes_in_table_infor8dictr;_max_string_length _view_supportr _metadatareflect)r<enginer4metadata ignore_tablesinclude_tablessample_rows_in_table_infoindexes_in_table_infocustom_table_info view_supportmax_string_lengthlazy_table_reflectionmissing_tables usable_tablesr;s` @r$__init__zSQLDatabase.__init__2sE  mST T!$,,/ 000? @@Lt--V-2#%   !11D4D4DDN %n%55KL5Bc-0su   !0043C3CCN $^$44JK335 4Ac-0tGWGW3S9JK K*C'&;#"3  " "d55t<3 t667DDTEUEUVL&*+!44+'D # #4)!/XZ$ NN " ""\\$--.|| # %r&c 4|xsi}|t|fi|fi|S)z'Construct a SQLAlchemy engine from URI.)r)cls database_uri engine_argskwargs _engine_argss r$from_urizSQLDatabase.from_uris(#(b =>>I&IIr&z0.3.18zFor performing structured retrieval using Databricks SQL, see the latest best practices and recommended APIs at https://docs.unitycatalog.io/ai/integrations/langchain/ insteadz1.0)messageremovalc  ddlm} d} ddlm} | } | j } | tdd| }| r | jnd} | tdd | }||| r | j}n td |r |r td |rd |}nd |}d|d|d|d|d| }|jd||d|S#t$r tdwxYw#tt f$rd} YwxYw)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_contexthostDATABRICKS_HOST api_tokenDATABRICKS_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=)rgrh) databricksro ImportError!dbruntime.databricks_repl_contextrpbrowserHostNameAttributeErrorrapiToken clusterIdrDrk)rfcatalogr4rqrs warehouse_id cluster_idrhrirocontextrp default_hostdefault_api_token http_pathuris r$from_databrickszSQLDatabase.from_databrickssJx  &  E!mG"22L <(9<HD07G,,T  $[2DFWXI  J$6$..  L JNO O .|n=I.zl;I")AdV4" 9WIXfX G s||P+PPPS :  ^, L sB2C 2C CCc| ddlm}||||||}|j|S#t$r tdwxYw)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)rgzRcnos-connector package not found, please install with `pip install cnos-connector`)cnosdb_connectorrrkrx)rfurluserpasswordtenantdatabaserrs r$ from_cnosdbzSQLDatabase.from_cnosdbsN<  B+CxRC<t-t/| j1|j} | j3} |j4xs |j6}|r| dz } |j4r| d|j9| dz } |j6r| d|j;| dz } |r| dz } |j| k|j=d j?|}|Scc}wcc}w) 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. z table_names r5r>sqlitesqlite_z /* z*/z ) rMrF differencerDrV sorted_tablesrrWrUrBrGrCr startswithr8appendcolumnsitemstyper_columnsremover"rcompilerstriprRrQ_get_table_indexes_get_sample_rowssortjoin)r< table_namesall_table_namesrbtblmetadata_table_names to_reflect meta_tablestablesr:kv create_tablerhas_extra_info final_strs r$rzSQLDatabase.get_table_info4s557  " -88IN </??U!VWW)O48NN4P4PQSQQ)C0D,EE  NN " "((\\*%|| # ~~33 xx3//\\X-#((2E2Ei2P     &E&&5::9P9P+P d55ejjAB ++- -1<8+NN))!, - {5199$,,GHL(//12J++Nt/N/N h& **4#:#:5#A"B"EE ..4#8#8#?"@CC d" MM* %1 &2  KK' [ R s K$A Kc|jj|j}djt t |}d|S)NrzTable Indexes: )rE get_indexesrrmapr%)r<r:indexesindexes_formatteds r$rzSQLDatabase._get_table_indexests?//--ejj9 IIc-&AB!"3!455r&c2t|j|j}dj|jDcgc]}|j c}} |j j5}|j|}ttd|}ddddjDcgc]}dj|c}} |jd|j d|d| Scc}w#1swY]xYwcc}w#t$rd} YDwxYw)N cD|Dcgc]}t|ddc}Scc}w)Ndr!)lsis r$z.SQLDatabase._get_sample_rows..s"#=QCF4CL#=#=srz rows from z table: ) rlimitrQrrrrBconnectexecuterGrr) r<r:commandcol columns_str connectionsample_rows_result sample_rowsrowsample_rows_strs r$rzSQLDatabase._get_sample_rowsys-%%d&E&EFiiU]] Cc CD  !%%' :%/%7%7%@""=?QR  #ii;(OC3(OPO../{5::,im2 ! '!D  )P  ! O !s;C2D3(C7D2D D7D< D DD parametersexecution_optionsc|xsi}|xsi}|jj5}|j<|jdk(r!|j d|jf|n |jdk(r |j d|jf|n|jdk(rn|jdk(r |j d |jf|n|jd k(r!|j d |j|nn|jd k(r!|j d |j|n>|jdk(rn.|jdk(r|j d|jf|t |t r t|}n(t |trntdt||j|||}|jr|dk(r,|jDcgc]}|j}}nF|dk(r&|j} | gn| jg}n|dk(r |cdddSt!d|cdddS dddgScc}w#1swYgSxYw)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)rbigqueryzSET @@dataset_id=?mssqltrinozUSE ?duckdbzSET search_path TO oraclez#ALTER SESSION SET CURRENT_SCHEMA = sqlany postgresqlzSET search_path TO %sz#Query expression has unknown type: allonecursorz8Fetch parameter must be either 'one', 'all', or 'cursor')rBbeginrCrexec_driver_sqlr+r"rrrPrr returns_rowsfetchall_asdictfetchonerD) r<rfetchrrrrxresult first_results r$_executezSQLDatabase._executes %2 -3 \\   !G Z||'<<;...<*;/ \\Z/..,*;/ \\W,\\W,..*;/ \\X- ..-dll^<*;/\\X-..=dll^L*;/\\X-\\\1../*;/ '3'w-GZ0"Ed7m_ UVV''"3(F ""E>39??3DEaaiikEFEe^#)??#4L#/#7Rl>R>R>T=UFh&!EG G H%ROG G v#wG P F{G P s$GI',I"4I' I'"I''I1c^|j||||}|dk(r|S|D cgc];}|jD cic]\}} |t| |jc} }=} }}} |s&| D cgc]} t | j } } | syt | Scc} }wcc} }}wcc} w)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. rr)r/r)rrr0rTtuplevaluesr") r<rrinclude_columnsrrrrcolumnvalueresrs r$runzSQLDatabase.runs UzEV  H M   &'WWY !FE eD4K4KLL   25635&6C6s8O  7sB#"BB#- B*B#c^ |j|S#t$r} d|cYd}~Sd}~wwxYw)rError: N)rrD)r<res r$get_table_info_no_throwz#SQLDatabase.get_table_info_no_throws7 !&&{3 3 ! *QC=  !s ,',,ch |j|||||S#t$r} d|cYd}~Sd}~wwxYw)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)r<rrrrrrs r$ run_no_throwzSQLDatabase.run_no_throw%sM !88%"3 /   ! *QC=  !s 1,11c|t|j}|j}|dj|dS)z4Return db context that you may want in agent prompt.z, )rr)rGrMrr)r<rrs r$rpzSQLDatabase.get_contextAs746689 113 (;9OPPr&) NNNNFNFi,F)rXrr4 Optional[str]rYzOptional[MetaData]rZOptional[List[str]]r[rr\rOr]boolr^Optional[dict]r_rr`rOrarr7)rgzUnion[str, URL]rhrrirreturnr2)NNNNN)r~r"r4r"rqrrsrrrrrrhrrirrr2)z127.0.0.1:8902rootrcnosdbpublic) rr"rr"rr"rr"rr"rr2)rr")rz Iterable[str])rrrr")r:rrr")r) rUnion[str, Executable]rLiteral['all', 'one', 'cursor']rOptional[Dict[str, Any]]rrrz'Union[Sequence[Dict[str, Any]], Result])rF) rrrrrrrrrrr1Union[str, Sequence[Dict[str, Any]], Result[Any]]) rr"rzLiteral['all', 'one']rrrrrrrr )rzDict[str, Any])__name__ __module__ __qualname____doc__rd classmethodrkr rrpropertyrrMrHrrrrrrrrrprvr&r$r2r2/sV/ !%'+-1.2)*&+,0"!$&+NNN% N + N , N$'N $N*NNN $N`'+J%J$J J  JJ ##'&*$(&*^Q^Q^Q ^Q ! ^Q $ ^Q"^Q$^Q^Q ^Q^Q@$ & && &  &  & &&P))> %=uM-N-%%>@6  B27W 046: W'W/W - W 4 W 1Wx27 % # 046:#'#/# # - #4# ;#J!&(- % ! 046:!!%! ! - !4! ;!8Qr&r2)r#z+sqlalchemy.engine.interfaces.ReflectedIndexrr")r.rr/rOr'r"rr")'r  __future__rtypingrrrrr r r r sqlalchemylangchain_core._apir langchain_core.utilsrrrrrrrsqlalchemy.enginerrrsqlalchemy.excrrsqlalchemy.schemarsqlalchemy.sql.expressionrsqlalchemy.typesrr%r0r2rvr&r$rsZ+"PPP*-21<)0%?D FVQVQr&