VhGddlmZmZmZeZdZdZdZddl m Z ddl m Z ddl mZmZmZmZmZmZdZGd d eZd Zed k(rey y ))absolute_importdivisionprint_functiona? --- module: postgresql_idx short_description: Create or drop indexes from a PostgreSQL database description: - Create or drop indexes from a PostgreSQL database. options: idxname: description: - Name of the index to create or drop. type: str required: true aliases: - name login_db: description: - Name of database to connect to and where the index will be created/dropped. - The V(db) alias is deprecated and will be removed in version 5.0.0. type: str aliases: - db session_role: description: - Switch to session_role after connecting. The specified session_role must be a role that the current login_user is a member of. - Permissions checking for SQL commands is carried out as though the session_role were the one that had logged in originally. type: str schema: description: - Name of a database schema where the index will be created. type: str state: description: - Index state. - C(present) implies the index will be created if it does not exist. - C(absent) implies the index will be dropped if it exists. type: str default: present choices: [ absent, present ] table: description: - Table to create index on it. - Mutually exclusive with I(state=absent). type: str columns: description: - List of index columns that need to be covered by index. - Mutually exclusive with I(state=absent). type: list elements: str aliases: - column cond: description: - Index conditions. - Mutually exclusive with I(state=absent). type: str idxtype: description: - Index type (like btree, gist, gin, etc.). - Mutually exclusive with I(state=absent). type: str aliases: - type concurrent: description: - Enable or disable concurrent mode (CREATE / DROP INDEX CONCURRENTLY). - Pay attention, if I(concurrent=false), the table will be locked (ACCESS EXCLUSIVE) during the building process. For more information about the lock levels see U(https://www.postgresql.org/docs/current/explicit-locking.html). - If the building process was interrupted for any reason when I(cuncurrent=true), the index becomes invalid. In this case it should be dropped and created again. - Mutually exclusive with I(cascade=true). type: bool default: true unique: description: - Enable unique index. - Only btree currently supports unique indexes. type: bool default: false version_added: '0.2.0' tablespace: description: - Set a tablespace for the index. - Mutually exclusive with I(state=absent). type: str storage_params: description: - Storage parameters like fillfactor, vacuum_cleanup_index_scale_factor, etc. - Mutually exclusive with I(state=absent). type: list elements: str cascade: description: - Automatically drop objects that depend on the index, and in turn all objects that depend on those objects. - It used only with I(state=absent). - Mutually exclusive with I(concurrent=true). type: bool default: false trust_input: description: - If C(false), check whether values of parameters I(idxname), I(session_role), I(schema), I(table), I(columns), I(tablespace), I(storage_params), I(cond) are potentially dangerous. - It makes sense to use C(false) only when SQL injections via the parameters are possible. type: bool default: true version_added: '0.2.0' seealso: - module: community.postgresql.postgresql_table - module: community.postgresql.postgresql_tablespace - name: PostgreSQL indexes reference description: General information about PostgreSQL indexes. link: https://www.postgresql.org/docs/current/indexes.html - name: CREATE INDEX reference description: Complete reference of the CREATE INDEX command documentation. link: https://www.postgresql.org/docs/current/sql-createindex.html - name: ALTER INDEX reference description: Complete reference of the ALTER INDEX command documentation. link: https://www.postgresql.org/docs/current/sql-alterindex.html - name: DROP INDEX reference description: Complete reference of the DROP INDEX command documentation. link: https://www.postgresql.org/docs/current/sql-dropindex.html notes: - The index building process can affect database performance. - To avoid table locks on production databases, use I(concurrent=true) (default behavior). attributes: check_mode: support: full author: - Andrew Klychkov (@Andersson007) - Thomas O'Donnell (@andytom) extends_documentation_fragment: - community.postgresql.postgres aG - name: Create btree index if not exists test_idx concurrently covering columns id and name of table products community.postgresql.postgresql_idx: login_db: acme table: products columns: id,name name: test_idx - name: Create btree index test_idx concurrently with tablespace called ssd and storage parameter community.postgresql.postgresql_idx: login_db: acme table: products columns: - id - name idxname: test_idx tablespace: ssd storage_params: - fillfactor=90 - name: Create gist index test_gist_idx concurrently on column geo_data of table map community.postgresql.postgresql_idx: login_db: somedb table: map idxtype: gist columns: geo_data idxname: test_gist_idx # Note: for the example below pg_trgm extension must be installed for gin_trgm_ops - name: Create gin index gin0_idx not concurrently on column comment of table test community.postgresql.postgresql_idx: idxname: gin0_idx table: test columns: comment gin_trgm_ops concurrent: false idxtype: gin - name: Drop btree test_idx concurrently community.postgresql.postgresql_idx: login_db: mydb idxname: test_idx state: absent - name: Drop test_idx cascade community.postgresql.postgresql_idx: login_db: mydb idxname: test_idx state: absent cascade: true concurrent: false - name: Create btree index test_idx concurrently on columns id,comment where column id > 1 community.postgresql.postgresql_idx: login_db: mydb table: test columns: id,comment idxname: test_idx cond: id > 1 - name: Create unique btree index if not exists test_unique_idx on column name of table products community.postgresql.postgresql_idx: login_db: acme table: products columns: name name: test_unique_idx unique: true concurrent: false a name: description: Index name. returned: success type: str sample: 'foo_idx' state: description: Index state. returned: success type: str sample: 'present' schema: description: Schema where index exists. returned: success type: str sample: 'public' tablespace: description: Tablespace where index exists. returned: success type: str sample: 'ssd' query: description: Query that was tried to be executed. returned: success type: str sample: 'CREATE INDEX CONCURRENTLY foo_idx ON test_table USING BTREE (id)' storage_params: description: Index storage parameters. returned: success type: list sample: [ "fillfactor=90" ] valid: description: Index validity. returned: success type: bool sample: true ) AnsibleModule) check_input) connect_to_dbensure_required_libsexec_sqlget_conn_paramspg_cursor_argspostgres_common_argument_spec)BTREEHASHGISTSPGISTGINBRINc4eZdZdZdZdZdZ ddZd dZy) IndexaClass for working with PostgreSQL indexes. TODO: 1. Add possibility to change ownership 2. Add possibility to change tablespace 3. Add list called executed_queries (executed_query should be left too) 4. Use self.module instead of passing arguments to the methods whenever possible Args: module (AnsibleModule) -- object of AnsibleModule class cursor (cursor) -- cursor object of psycopg library schema (str) -- name of the index schema name (str) -- name of the index Attrs: module (AnsibleModule) -- object of AnsibleModule class cursor (cursor) -- cursor object of psycopg library schema (str) -- name of the index schema name (str) -- name of the index exists (bool) -- flag the index exists in the DB or not info (dict) -- dict that contents information about the index executed_query (str) -- executed query c||_|r||_nd|_||_||_|jdddddgd|_d|_|j d|_y)NpublicabsentTnamestateschematblnametblspacevalidstorage_paramsF)rrmodulecursorinfoexists_Index__exists_in_dbexecuted_query)selfr"r#rrs w/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/postgresql/plugins/modules/postgresql_idx.py__init__zIndex.__init__3sg  DK"DK  II      c:|j|jS)z"z CASCADETr@)r%rrr'r )r(cascaderEr8s r)dropz Index.drops]{{  _ $E dii88  Z E#euMMr+N)TF)FT) __name__ __module__ __qualname____doc__r*r-r&rGrKr+r)rrs)0!*D8=1NfNr+rcJ t}|jtdddgtddgddddg tdd d d g td dtd dtdtddgtdddgtdtdtdtddtd dtdtd dt|d}|jd}|jd}|jd}|jd}|jd}|jd}|jd}|jd } |jd!} |jd"} |jd#} |jd$} |jd%}|jd&}|st |||| ||| | | |r| r|j d'(|r|r|d)k7r|j d*(|d k(r)|s|j d+(|s2|j d,(n|s|s| s|s| r|j d-|z(| r|d k7r|j d.(t|t||j}t||d/\}}|jd9it}d}t||| |}|j}d0|d1<|jr|d k(r$|jrd|d2<|j d9i|nz|d k(r$|jsd|d2<|j d9i|nQ|d k(r$|jsd|d2<|j d9i|n(|d k(r#|jrd|d2<|j d9i||d k(r|r/|j#t$vr|j d3|d4|d5(d6j'|}| rd6j'| } |j)|||| | | ||}|rM|j}d |d<|j*|d1<n(|j-| |}|rd |d<|j*|d1<|d7s$|j/|j1d8|z|s|j3||d2<|j5|j d9i|y):NstrTr)typerequiredaliasesdbz5.0.0zcommunity.postgresql)rversioncollection_name)rSrUdeprecated_aliasesr1r)rSdefaultchoicesbool)rSrZF)rSrS)rSrUlistcolumn)rSelementsrU)rSr_)idxnamelogin_dbrrErFtablerBrCrD session_roler4r!rJr trust_input) argument_specsupports_check_moder`rrErFrbrBrCrDr4r!rJrrcrdz=Concurrent mode and cascade parameters are mutually exclusive)msgbtreez,Only btree currently supports unique indexeszTable must be specifiedz%At least one column must be specifiedzIndex %s is going to be removed, so it does not make sense to pass a table name, columns, conditions, index type, or tablespacez-cascade parameter used only with state=absent) autocommitrr8changedz Index type 'z' of z is not in valid types,r zIndex %s is invalid! ROLLBACKrP)r updater7rparamsr fail_jsonr r rr#r rr- check_moder% exit_jsonupperVALID_IDX_TYPESjoinrGr'rKrollbackwarncommitclose)rer"r`rrErFrbrBrCrDr4r!rJrrcrd conn_params db_connectiondummyr#rjindexkws r)mainr}s13M%$A54&"#9 F y8Y:OPVT2/%&2&58*E u u%U#%8&%0fd3+.# F mmI&G MM' "E|,J ]]8 $F MM' "EmmI&GmmI&G == D|,J]]#34NmmI&G ]]8 $F==0L-- .K FG\65' 6g\] 7w'1KL    !:  ;   !H  I Gtw*   "=?F"G  H5H$LM !&&--8K(NM5 !] ! ! 3N 3FG &&&' 2E  BBwK I %,,!ByM F   "r " i   ByM F   "r " h u||!ByM F   "r " h 5<< ByM F   "r "  w}}o=   RY[b!c  d((7#  XXn5N,,ugwj.Zdflm !B#BwK..BwK**Wj1 "BwK..BwK g;  3g=> ByMFrr+__main__N) __future__rrrrS __metaclass__ DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicrFansible_collections.community.postgresql.plugins.module_utils.databaserFansible_collections.community.postgresql.plugins.module_utils.postgresrr r r r r rrobjectrr}rLrPr+r)rsuA@ N `C J$ L5EgNFgN^IX zFr+