[{"_1":2,"_153":-5,"_154":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_132":133},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":131},"canonicalUrl","https://hub.docker.com/r/bessonovevgen/pgslice/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","bessonovevgen","reponame","pgslice","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2018-12-10T14:48:53.96602Z","description","!","is_private","last_updated","2018-12-10T14:53:38.502981Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",214,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# pgslice\n\nPostgres partitioning as easy as pie. Works great for both new and existing tables, with zero downtime and minimal app changes. No need to install anything on your database server. Archive older data on a rolling basis to keep your database size under control.\n\n:tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)\n\n[![Build Status](https://travis-ci.org/ankane/pgslice.svg?branch=master)](https://travis-ci.org/ankane/pgslice)\n\n## Install\n\npgslice is a command line tool. To install, run:\n\n```sh\ngem install pgslice\n```\n\nThis will give you the `pgslice` command.\n\n## Steps\n\n1. Ensure the table you want to partition has been created. We’ll refer to this as ``.\n\n2. Specify your database credentials\n\n ```sh\n export PGSLICE_URL=postgres://localhost/myapp_development\n ```\n\n3. Create an intermediate table\n\n ```sh\n pgslice prep

\n ```\n\n Period can be `day`, `month`, or `year`.\n\n This creates a table named `

_intermediate` with the appropriate trigger for partitioning.\n\n4. Add partitions\n\n ```sh\n pgslice add_partitions

--intermediate --past 3 --future 3\n ```\n\n This creates child tables that inherit from the intermediate table.\n\n Use the `--past` and `--future` options to control the number of partitions.\n\n5. *Optional, for tables with data* - Fill the partitions in batches with data from the original table\n\n ```sh\n pgslice fill

\n ```\n\n Use the `--batch-size` and `--sleep` options to control the speed.\n\n To sync data across different databases, check out [pgsync](https://github.com/ankane/pgsync).\n\n6. Analyze tables\n\n ```sh\n pgslice analyze

\n ```\n\n7. Swap the intermediate table with the original table\n\n ```sh\n pgslice swap

\n ```\n\n The original table is renamed `

_retired` and the intermediate table is renamed `

`.\n\n8. Fill the rest (rows inserted between the first fill and the swap)\n\n ```sh\n pgslice fill

--swapped\n ```\n\n9. Back up the retired table with a tool like [pg_dump](https://www.postgresql.org/docs/current/static/app-pgdump.html) and drop it\n\n ```sql\n pg_dump -c -Fc -t

_retired $PGSLICE_URL >

_retired.dump\n psql -c \"DROP

_retired\" $PGSLICE_URL\n ```\n\n## Sample Output\n\npgslice prints the SQL commands that were executed on the server. To print without executing, use the `--dry-run` option.\n\n```sh\npgslice prep visits created_at month\n```\n\n```sql\nBEGIN;\n\nCREATE TABLE \"public\".\"visits_intermediate\" (LIKE \"public\".\"visits\" INCLUDING DEFAULTS INCLUDING CONSTRAINTS INCLUDING STORAGE INCLUDING COMMENTS) PARTITION BY RANGE (\"created_at\");\n\nCREATE INDEX ON \"public\".\"visits_intermediate\" USING btree (\"created_at\");\n\nCOMMENT ON TABLE \"public\".\"visits_intermediate\" is 'column:createdAt,period:day,cast:date,version:3';\n\nCOMMIT;\n```\n\n```sh\npgslice add_partitions visits --intermediate --past 1 --future 1\n```\n\n```sql\nBEGIN;\n\nCREATE TABLE \"public\".\"visits_201808\" PARTITION OF \"public\".\"visits_intermediate\" FOR VALUES FROM ('2018-08-01') TO ('2018-09-01');\n\nALTER TABLE \"public\".\"visits_201808\" ADD PRIMARY KEY (\"id\");\n\nCREATE TABLE \"public\".\"visits_201809\" PARTITION OF \"public\".\"visits_intermediate\" FOR VALUES FROM ('2018-09-01') TO ('2018-10-01');\n\nALTER TABLE \"public\".\"visits_201809\" ADD PRIMARY KEY (\"id\");\n\nCREATE TABLE \"public\".\"visits_201810\" PARTITION OF \"public\".\"visits_intermediate\" FOR VALUES FROM ('2018-10-01') TO ('2018-11-01');\n\nALTER TABLE \"public\".\"visits_201808\" ADD PRIMARY KEY (\"id\");\n\nCOMMIT;\n```\n\n```sh\npgslice fill visits\n```\n\n```sql\n/* 1 of 3 */\nINSERT INTO \"public\".\"visits_intermediate\" (\"id\", \"user_id\", \"ip\", \"created_at\")\n SELECT \"id\", \"user_id\", \"ip\", \"created_at\" FROM \"public\".\"visits\"\n WHERE \"id\" > 0 AND \"id\" <= 10000 AND \"created_at\" >= '2018-08-01'::date AND \"created_at\" < '2018-11-01'::date\n\n/* 2 of 3 */\nINSERT INTO \"public\".\"visits_intermediate\" (\"id\", \"user_id\", \"ip\", \"created_at\")\n SELECT \"id\", \"user_id\", \"ip\", \"created_at\" FROM \"public\".\"visits\"\n WHERE \"id\" > 10000 AND \"id\" <= 20000 AND \"created_at\" >= '2018-08-01'::date AND \"created_at\" < '2018-11-01'::date\n\n/* 3 of 3 */\nINSERT INTO \"public\".\"visits_intermediate\" (\"id\", \"user_id\", \"ip\", \"created_at\")\n SELECT \"id\", \"user_id\", \"ip\", \"created_at\" FROM \"public\".\"visits\"\n WHERE \"id\" > 20000 AND \"id\" <= 30000 AND \"created_at\" >= '2018-08-01'::date AND \"created_at\" < '2018-11-01'::date\n```\n\n```sh\npgslice analyze visits\n```\n\n```sql\nANALYZE VERBOSE \"public\".\"visits_201808\";\n\nANALYZE VERBOSE \"public\".\"visits_201809\";\n\nANALYZE VERBOSE \"public\".\"visits_201810\";\n\nANALYZE VERBOSE \"public\".\"visits_intermediate\";\n```\n\n```sh\npgslice swap visits\n```\n\n```sql\nBEGIN;\n\nSET LOCAL lock_timeout = '5s';\n\nALTER TABLE \"public\".\"visits\" RENAME TO \"visits_retired\";\n\nALTER TABLE \"public\".\"visits_intermediate\" RENAME TO \"visits\";\n\nALTER SEQUENCE \"visits_id_seq\" OWNED BY \"public\".\"visits\".\"id\";\n\nCOMMIT;\n```\n\n## Adding Partitions\n\nTo add partitions, use:\n\n```sh\npgslice add_partitions

--future 3\n```\n\nAdd this as a cron job to create a new partition each day, month, or year.\n\n```sh\n# day\n0 0 * * * pgslice add_partitions

--future 3 --url ...\n\n# month\n0 0 1 * * pgslice add_partitions

--future 3 --url ...\n\n# year\n0 0 1 1 * pgslice add_partitions

--future 3 --url ...\n```\n\nAdd a monitor to ensure partitions are being created.\n\n```sql\nSELECT 1 FROM\n pg_catalog.pg_class c\nINNER JOIN\n pg_catalog.pg_namespace n ON n.oid = c.relnamespace\nWHERE\n c.relkind = 'r' AND\n n.nspname = 'public' AND\n c.relname = '

_' || to_char(NOW() + INTERVAL '3 days', 'YYYYMMDD')\n -- for months, use to_char(NOW() + INTERVAL '3 months', 'YYYYMM')\n -- for years, use to_char(NOW() + INTERVAL '3 years', 'YYYY')\n```\n\n## Archiving Partitions\n\nBack up and drop older partitions each day, month, or year.\n\n```sh\npg_dump -c -Fc -t

_201809 $PGSLICE_URL >

_201809.dump\npsql -c \"DROP

_201809\" $PGSLICE_URL\n```\n\nIf you use [Amazon S3](https://aws.amazon.com/s3/) for backups, [s3cmd](https://github.com/s3tools/s3cmd) is a nice tool.\n\n```sh\ns3cmd put

_201809.dump s3:///

_201809.dump\n```\n\n## Additional Commands\n\nTo undo prep (which will delete partitions), use:\n\n```sh\npgslice unprep

\n```\n\nTo undo swap, use:\n\n```sh\npgslice unswap

\n```\n\n## App Considerations\n\nThis set up allows you to read and write with the original table name with no knowledge it’s partitioned. However, there are a few things to be aware of.\n\n### Reads\n\nWhen possible, queries should include the column you partition on to limit the number of partitions the database needs to check. For instance, if you partition on `created_at`, try to include it in queries:\n\n```sql\nSELECT * FROM\n visits\nWHERE\n user_id = 123 AND\n -- for performance\n created_at >= '2018-09-01' AND created_at < '2018-09-02'\n```\n\nFor this to be effective, ensure `constraint_exclusion` is set to `partition` (default value) or `on`.\n\n```sql\nSHOW constraint_exclusion;\n```\n\n### Writes\n\nBefore Postgres 10, if you use `INSERT` statements with a `RETURNING` clause (as frameworks like Rails do), you’ll no longer receive the id of the newly inserted record(s) back. If you need this, you can either:\n\n1. Insert directly into the partition\n2. Get value before the insert with `SELECT nextval('sequence_name')` (for multiple rows, append `FROM generate_series(1, n)`)\n\n## One Off Tasks\n\nYou can also use pgslice to reduce the size of a table without partitioning by creating a new table, filling it with a subset of records, and swapping it in.\n\n```sh\npgslice prep

--no-partition\npgslice fill

--where \"id > 1000\" # use any conditions\npgslice swap

\n```\n\n## Schema Updates\n\nOnce a table is partitioned, here’s how to change the schema:\n\n- To add, remove, or modify a column, make the update on the master table only.\n- To add or remove an index or foreign key, make the update on the master table. For Postgres < 11, make the update on all partitions as well.\n\n## Declarative Partitioning\n\nPostgres 10 introduces [declarative partitioning](https://www.postgresql.org/docs/10/static/ddl-partitioning.html#ddl-partitioning-declarative). A major benefit is `INSERT` statements with a `RETURNING` clause work as expected. If you prefer to use trigger-based partitioning instead (not recommended), pass the `--trigger-based` option to the `prep` command.\n\n## Data Protection\n\nAlways make sure your [connection is secure](https://ankane.org/postgres-sslmode-explained) when connecting to your database over a network you don’t fully trust. Your best option is to connect over SSH or a VPN. Another option is to use `sslmode=verify-full`. If you don’t do this, your database credentials can be compromised.\n\n## Upgrading\n\nRun:\n\n```sh\ngem install pgslice\n```\n\nTo use master, run:\n\n```sh\ngem install specific_install\ngem specific_install https://github.com/ankane/pgslice.git\n```\n\n## Docker\n\n```sh\ndocker build -t pgslice .\nalias pgslice=\"docker run --rm -e PGSLICE_URL pgslice\"\n```\n\nThis will give you the `pgslice` command.\n\n## Reference\n\n- [PostgreSQL Manual](https://www.postgresql.org/docs/current/static/ddl-partitioning.html)\n- [PostgreSQL Wiki](https://wiki.postgresql.org/wiki/Table_partitioning)\n\n## Related Projects\n\nAlso check out:\n\n- [PgHero](https://github.com/ankane/pghero) - A performance dashboard for Postgres\n- [pgsync](https://github.com/ankane/pgsync) - Sync Postgres data to your local machine\n\n## Contributing\n\nEveryone is encouraged to help improve this project. Here are a few ways you can help:\n\n- [Report bugs](https://github.com/ankane/pgslice/issues)\n- Fix bugs and [submit pull requests](https://github.com/ankane/pgslice/pulls)\n- Write, clarify, or fix documentation\n- Suggest or add new features\n\nTo run tests, do:\n\n```sh\ngit clone https://github.com/ankane/pgslice.git\ncd pgslice\nbundle install\ncreatedb pgslice_test\nbundle exec rake\n```\n\nTo test against different versions of Postgres with Docker, use:\n\n```sh\ndocker run -p=8000:5432 postgres:10\nTZ=Etc/UTC PGSLICE_URL=postgres://postgres@localhost:8000/postgres bundle exec rake\n```\n\nOn Mac, you must use [Docker for Mac](https://www.docker.com/docker-mac) for the port mapping to localhost to work.\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",96414719,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",905308,"full_size",96405657,"id",42040359,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:3c82fb2627815ecb2633f2a32c188df421dcc2f4712537a8d27d4c4bb65739ac","features","","last_pulled","2026-09-15T12:05:39.16030527Z","last_pushed","2018-12-10T14:53:38Z","os","linux","os_features","os_version","size","variant","2018-12-10T14:53:37.775712Z","last_updater","last_updater_username","media_type","latest","repository",6412722,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":134,"_141":142,"_130":151,"_152":11},{"_36":135,"_38":136,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":137,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":138,"_75":17,"_76":140,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":139},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_143":60,"_144":-5,"_145":-5,"_146":147},"count","next","previous","results",[148],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":149,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[150],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

bessonovevgen/pgslice

Tags for bessonovevgen/pgslice