One place for hosting & domains

      So verwalten Sie sortierte Sets in Redis


      Einführung

      Redis ist ein Open-Source-, In-Memory-Datenspeicher mit Schlüsselwerte-Datenstruktur. Sortierte Sets in Redis sind ein Datentyp, der den Sets ähnelt. Beide sind Gruppen von Zeichenfolgen, die keine Wiederholungen zulassen. Der Unterschied besteht darin, dass in einem sortierten Set jedes Mitglied mit einem Score verknüpft ist, wodurch diese vom kleinsten bis zum größten Score sortiert werden können. So wie bei Sets darf jedes Mitglied eines sortieren Sets in diesem nur einmalig vorkommen, wobei mehrere Mitglieder den gleichen Score haben können.

      Dieses Tutorial erklärt, wie man sortierte Sets erstellt, Ihre Mitglieder abruft und entfernt und wie man neue sortierte Sets aus bestehenden Sets erstellen kann.

      So verwenden Sie diesen Leitfaden

      Dieser Leitfaden ist wie ein Spickzettel mit eigenständigen Beispielen geschrieben. Sie können beliebig zu jedem Abschnitt springen, der zu der Aufgabe passt, die Sie ausführen möchten.

      Die in diesem Leitfaden verwendeten Befehle wurden auf einem Ubuntu 18.04-Server mit der Redis-Version 4.0.9 getestet. Um eine ähnliche Umgebung einzurichten, können Sie Schritt 1 unseres Leitfadens Installieren und Sichern von Redis unter Ubuntu 18.04 folgen. Wir zeigen, wie diese Befehle sich verhalten, wenn sie mit redis-cli, der Befehlszeilenschnittstelle von Redis, angewendet werden. Beachten Sie, dass bei der Anwendung einer anderen Redis-Schnittstelle – z. B. Redli – die genaue Ausgabe bestimmter Befehle abweichen kann.

      Alternativ können Sie ein verwaltetes Exemplar einer Redis-Datenbank bereitstellen, um diese Befehle zu testen. Beachten Sie jedoch, dass abhängig vom Kontrollniveau, das Ihr Datenbankanbieter erlaubt, einige Befehle in diesem Leitfaden nicht wie beschrieben funktionieren könnten. Um eine von DigitalOcean verwaltete Datenbank bereitzustellen, folgen Sie bitte unserer Produktdokumentation über verwaltete Datenbanken. Dann müssen Sie entweder Redli installieren oder einen TLS-Tunnel einrichten, um sich mit der verwalteten Datenbank über TLS zu verbinden.

      Erstellen von sortierten Sets und Hinzufügen von Mitgliedern

      Um ein sortiertes Set zu erstellen, verwenden Sie den Befehl zadd. zadd akzeptiert als Argumente den Namen des Schlüssels, der das sortierte Set speichert, gefolgt vom Score des Mitglieds, das Sie hinzufügen, sowie dem Wert des Mitglieds selbst. Der folgende Befehl erstellt den Schlüssel eines sortierten Sets namens faveGuitarists mit einem Mitglied, "Joe Pass", das einen Score von 1 hat:

      • zadd faveGuitarists 1 "Joe Pass"

      zadd gibt eine ganze Zahl (Integer) aus, die anzeigt, wie viele Mitglieder dem sortierten Set hinzugefügt wurden, wenn es erfolgreich erstellt wurde.

      Output

      (integer) 1

      Mit zadd können Sie einem sortierten Set mehr als ein Mitglied hinzufügen. Beachten Sie, dass deren Scores nicht sequenziell sein müssen. Zwischen den Scores kann es Lücken geben und mehrere Mitglieder aus demselben sortierten Set können den gleichen Score haben:

      • zadd faveGuitarists 4 "Stephen Malkmus" 2 "Rosetta Tharpe" 3 "Bola Sete" 3 "Doug Martsch" 8 "Elizabeth Cotten" 12 "Nancy Wilson" 4 "Memphis Minnie" 12 "Michael Houser"

      Output

      (integer) 8

      zadd kann die folgenden Optionen akzeptieren, die Sie nach dem Schlüsselnamen und vor dem ersten Score eines Mitglieds eingeben müssen:

      • NX oder XX: Diese Optionen haben gegensätzliche Effekte, daher können Sie nur eine davon in eine zadd-Operation einfügen:
        • NX weist zadd an, die bestehenden Mitglieder nicht zu aktualisieren. Mit dieser Option fügt zadd nur neue Elemente hinzu.
        • XX weist zadd an, nur bestehende Elemente zu aktualisieren. Mit dieser Option fügt zadd niemals neue Mitglieder hinzu.
      • CH: Normalerweise gibt zadd nur die Anzahl der neuen Elemente aus, die dem sortierten Set hinzugefügt werden. Doch mit dieser Option gibt zadd die Anzahl der geänderten Elemente aus. Dazu gehören neu hinzugefügte Mitglieder sowie Mitglieder, deren Scores geändert wurden.
      • INCR: Führt dazu, dass der Befehl den Score-Wert des Mitglieds inkrementiert. Wenn das Mitglied noch nicht existiert, fügt der Befehl es mit dem Inkrement als Score in das sortierte Set ein, so als wäre sein ursprünglicher Score 0. Mit INCR gibt zadd bei erfolgreicher Ausführung den neuen Score des Mitglieds aus. Beachten Sie, dass Sie mit dieser Option jeweils nur ein Score/Mitglied-Paar einbeziehen können.

      Statt INCR mit zadd einzugeben, können Sie stattdessen den Befehl zincrby verwenden, der sich genauso verhält. Statt so wie zadd dem Mitglied des sortierten Sets den durch den Score-Wert angezeigten Wert zu geben, inkrementiert er den Score des Mitglieds auf diesen Wert. Beispiel: Der folgende Befehl inkrementiert den Score des Mitglieds "Stephen Malkmus", der ursprünglich 4 war, um 5 auf 9.

      • zincrby faveGuitarists 5 "Stephen Malkmus"

      Output

      "9"

      So wie bei der zadd-Befehlsoption INCR wird zincrby, falls das angegebene Mitglied nicht existiert, es mit dem inkrementellen Wert als seinen Score kreieren.

      Abrufen von Mitgliedern aus sortierten Sets

      Die grundlegendste Möglichkeit, die in einem sortierten Set enthaltenen Mitglieder abzurufen, ist die Verwendung des Befehls zrange. Dieser Befehl akzeptiert als Argumente den Namen des Schlüssels, dessen Mitglieder Sie abrufen möchten und eine Reihe von darin enthaltenen Mitgliedern. Die Reihe ist durch zwei Zahlen definiert, die nullbasierte Indexe repräsentieren. Das bedeutet, dass 0 das erste Mitglied im sortierten Set (oder das Mitglied mit dem niedrigsten Score) repräsentiert, 1 repräsentiert das nächste, und so fort.

      Das folgende Beispiel gibt die ersten vier Mitglieder aus dem im vorherigen Abschnitt erstellten Set faveGuitarists aus:

      • zrange faveGuitarists 0 3

      Output

      1) "Joe Pass" 2) "Rosetta Tharpe" 3) "Bola Sete" 4) "Doug Martsch"

      Beachten Sie: Falls das sortierte Set, das Sie an zrange übergeben, zwei oder mehr Elemente hat, die den gleichen Score teilen, werden diese Elemente in lexikografischer oder alphabetischer Reihenfolge sortiert.

      Die Start- und Stopp-Indizes können auch negative Zahlen sein, wobei -1 das letzte Mitglied repräsentiert, -2 das vorletzte Mitglied, und so fort:

      • zrange faveGuitarists -5 -2

      Output

      1) "Memphis Minnie" 2) "Elizabeth Cotten" 3) "Stephen Malkmus" 4) "Michael Houser"

      zrange akzeptiert zudem das Argument WITHSCORES. Wenn es enthalten ist, gibt es auch die Scores der Mitglieder aus:

      • zrange faveGuitarists 5 6 WITHSCORES

      Output

      1) "Elizabeth Cotten" 2) "8" 3) "Stephen Malkmus" 4) "9"

      zrange kann eine Reihe von Mitgliedern nur in aufsteigender numerischer Reihenfolge ausgeben. Um das umzukehren und eine Reihe in absteigender Reihenfolge auszugeben, müssen Sie den Befehl zrevrange verwenden. Stellen Sie sich diesen Befehl als vorübergehende Umkehrung der Reihenfolge des gegebenen sortierten Sets vor der Ausgabe der Mitglieder vor, die in den angegebenen Bereich fallen. Bei zrevrange repräsentiert 0 das letzte im Schlüssel enthaltene Mitglied, 1 das vorletzte, und so fort:

      • zrevrange faveGuitarists 0 5

      Output

      1) "Nancy Wilson" 2) "Michael Houser" 3) "Stephen Malkmus" 4) "Elizabeth Cotten" 5) "Memphis Minnie" 6) "Doug Martsch"

      zrevrange akzeptiert auch die Option WITHSCORES.

      Mit dem Befehl zrangebyscore können Sie eine Reihe von Mitgliedern auf der Grundlage ihrer Scores ausgeben. Im folgenden Beispiel gibt der Befehl jedes Mitglied, das im Schlüssel faveGuitarists enthalten ist und einen Score von 2, 3 oder 4 hat, aus:

      • zrangebyscore faveGuitarists 2 4

      Output

      1) "Rosetta Tharpe" 2) "Bola Sete" 3) "Doug Martsch" 4) "Memphis Minnie"

      In diesem Beispiel ist die Reihe integrativ. Das bedeutet, dass sie Mitglieder mit Scores von 2 oder 4 ausgibt. Sie können jedes Ende der Reihe ausschließen, indem Sie eine offene Klammer davorsetzen ((). Das folgende Beispiel gibt jedes Mitglied mit einem Score, der größer oder gleich 2, jedoch kleiner als 4 ist, aus:

      • zrangebyscore faveGuitarists 2 (4

      Output

      1) "Rosetta Tharpe" 2) "Bola Sete" 3) "Doug Martsch"

      So wie bei zrange akzeptiert zrangebyscore das Argument WITHSCORES. Außerdem akzeptiert es die Option LIMIT, die Sie verwenden können, um nur eine Auswahl von Elementen aus der Ausgabe von zrangebyscore abzurufen. Diese Option akzeptiert ein Offset, das das erste Mitglied in der Reihe markiert, die der Befehl zurückgibt, sowie einen Zählstand, der festlegt, wie viele Mitglieder der Befehl insgesamt ausgibt. Der folgende Befehl z. B. konzentriert sich auf die ersten sechs Mitglieder des sortierten Sets faveGuitarists, gibt aber nur 3 dieser Mitglieder aus, beginnend mit dem zweiten Mitglied in der Reihe, repräsentiert durch 1:

      • zrangebyscore faveGuitarists 0 5 LIMIT 1 3

      Output

      1) "Rosetta Tharpe" 2) "Bola Sete" 3) "Doug Martsch"

      Der Befehl zrevrangebyscore gibt eine umgekehrte Reihe von Mitgliedern auf der Grundlage ihrer Scores aus. Der folgende Befehl gibt jedes Mitglied des Sets mit einem Score zwischen 10 und 6 aus:

      • zrevrangebyscore faveGuitarists 10 6

      Output

      1) "Stephen Malkmus" 2) "Elizabeth Cotten"

      So wie bei zrangebyscore kann zrevrangebyscore sowohl die Option WITHSCORES als auch die Option LIMIT akzeptieren. Außerdem können Sie jedes Ende der Reihe ausschließen, indem Sie vor dieses eine offene Klammer setzen.

      Es kann vorkommen, dass alle Mitglieder in einem sortierten Set den gleichen Score haben. In einem solchen Fall können Sie redis zwingen, mit dem Befehl zrangebylex eine Reihe von Elementen, die in lexikografischer oder in alphabetischer Reihenfolge sortiert sind, auszugeben. Um diesen Befehl auszuprobieren, führen Sie den folgenden zadd-Befehl aus, um ein sortiertes Set zu erstellen, in dem jedes Mitglied den gleichen Score hat:

      • zadd SomervilleSquares 0 Davis 0 Inman 0 Union 0 porter 0 magoun 0 ball 0 assembly

      Auf zrangebylex müssen ein Schlüsselname, ein Startintervall und ein Stoppinterval folgen. Die Start- und Stoppintervalle müssen mit einer offenen runden Klammer (() oder einer offenen eckigen Klammer ([) beginnen:

      • zrangebylex SomervilleSquares [a [z

      Output

      1) "assembly" 2) "ball" 3) "magoun" 4) "porter"

      Beachten Sie, dass dieses Beispiel nur vier der acht Mitglieder im Set ausgegeben hat, obwohl der Befehl eine Reihe von a bis z suchte. Das liegt daran, dass Redis-Werte groß-/kleinschreibungsabhängig sind. Daher wurden die Mitglieder, die mit Großbuchstaben beginnen, aus der Ausgabe ausgeschlossen. Um diese auszugeben, können Sie Folgendes ausführen:

      • zrangebylex SomervilleSquares [A [z

      Output

      1) "Davis" 2) "Inman" 3) "Union" 4) "assembly" 5) "ball" 6) "magoun" 7) "porter"

      zrangebylex akzeptiert auch die Sonderzeichen -, das negative Unendlichkeit, und +, das positive Unendlichkeit darstellt. Daher gibt die folgende Befehlssyntax auch jedes Mitglied des sortierten Sets aus:

      • zrangebylex SomervilleSquares - +

      Beachten Sie, dass zrangebylex Mitglieder eines sortierten Sets nicht in umgekehrter lexikografischer (ansteigend alphabetischer) Reihenfolge ausgeben kann. Hierfür verwenden Sie zrevrangebylex:

      • zrevrangebylex SomervilleSquares + -

      Output

      1) "porter" 2) "magoun" 3) "ball" 4) "assembly" 5) "Union" 6) "Inman" 7) "Davis"

      Da es für die Verwendung mit sortierten Sets bestimmt ist, bei denen jedes Mitglied den gleichen Score hat, akzeptiert zrangebylex nicht die Option WITHSCORES. Es akzeptiert jedoch die Option LIMIT.

      Abrufen von Informationen aus sortierten Sets

      Um herauszufinden, wie viele Mitglieder sich in einem gegebenen sortierten Set befinden (oder anders ausgedrückt, um seine Kardinalität zu bestimmen), verwenden Sie den Befehl zcard. Das folgende Beispiel zeigt, wie viele Mitglieder im Schlüssel faveGuitarists aus dem ersten Abschnitt dieses Leitfadens enthalten sind:

      Output

      (integer) 9

      zcount kann Ihnen zeigen, wie viele Elemente in einem gegebenen sortierten Set enthalten sind, die in einen Bereich von Scores fallen. Die erste Zahl, die auf den Schlüssel folgt, ist der Beginn des Bereichs und die zweite das Ende des Bereichs:

      • zcount faveGuitarists 3 8

      Output

      (integer) 4

      zscore gibt den Score eines angegebenen Mitglieds eines sortierten Sets aus:

      • zscore faveGuitarists "Bola Sete"

      Output

      "3"

      Wenn entweder das angegebene Mitglied oder der Schlüssel nicht existieren, gibt zscore als Ausgabe (nil) an.

      zrank ist ähnlich wie zscore, aber anstatt den Score des gegebenen Mitglieds auszugeben, gibt es stattdessen seinen Rang aus. In Redis ist Rang – rank – ein nullbasierter Index der Mitglieder eines sortierten Sets, der nach ihrem Score geordnet wird. Beispielsweise hat "Joe Pass" einen Score von 1, aber weil dies der niedrigste Score aller Mitglieder im Schlüssel ist, hat er den Rang 0:

      • zrank faveGuitarists "Joe Pass"

      Output

      (integer) 0

      Ein weiterer Redis-Befehl namens zrevrank führt die gleiche Funktion wie zrank aus, kehrt aber stattdessen den Rang der Mitglieder im Set um. Im folgenden Beispiel hat das Mitglied "Joe Pass" den niedrigsten Score und daraus folgend den höchsten umgekehrten Rang:

      • zrevrank faveGuitarists "Joe Pass"

      Output

      (integer) 8

      Die einzige Beziehung zwischen dem Score eines Mitglieds und seinem Rang besteht darin, wo sein Score im Verhältnis zu dem der anderen Mitglieder steht. Wenn zwischen zwei aufeinanderfolgenden Mitgliedern eine Lücke beim Score besteht, reflektiert sich diese nicht in ihrem Rang. Beachten Sie: Wenn zwei Mitglieder den gleichen Score haben, nimmt das Mitglied, das alphabetisch zuerst kommt, den unteren Rang ein.

      Wie zscore geben zrank und zrevrank als Ausgabe (nil) an, wenn der Schlüssel oder das Mitglied nicht existiert.

      zlexcount kann Ihnen zeigen, wie viele Mitglieder in einem sortierten Set innerhalb eines lexikografischen Bereichs enthalten sind. Das folgende Beispiel verwendet das sortierte Set SomervilleSquares aus dem vorherigen Abschnitt:

      • zlexcount SomervilleSquares [M [t

      Output

      (integer) 5

      Dieser Befehl folgt derselben Syntax wie der Befehl zrangebylex. Einzelheiten zum Definieren eines Stringbereichs entnehmen Sie dem vorherigen Abschnitt.

      Entfernen von Mitgliedern aus sortierten Sets

      Der Befehl zrem kann ein oder mehrere Mitglieder aus einem sortierten Set entfernen:

      • zrem faveGuitarists "Doug Martsch" "Bola Sete"

      zrem gibt eine ganze Zahl aus, die anzeigt, wie viele Mitglieder aus dem sortierten Set entfernt wurden:

      Output

      (integer) 2

      Es gibt drei Redis-Befehle, die es Ihnen ermöglichen, Mitglieder eines sortierten Sets auf der Grundlage eines Bereichs zu entfernen. Wenn z. B. jedes Mitglied in einem sortierten Set den gleichen Score hat, können Sie Mitglieder auf der Grundlage eines lexikografischen Bereichs mit zremrangebylex entfernen. Dieser Befehl verwendet die gleiche Syntax wie zrangebylex. Das folgende Beispiel entfernt jedes Mitglied, das mit einem Großbuchstaben beginnt, aus dem im vorherigen Abschnitt erstellten Schlüssel SomervilleSquares:

      • zremrangebylex SomervilleSquares [A [Z

      zremrangebylex gibt eine ganze Zahl an, die anzeigt, wie viele Mitglieder entfernt wurden:

      Output

      (integer) 3

      Außerdem können Sie Mitglieder auf der Grundlage eines Score-Bereichs mit dem Befehl zremrangebyscore entfernen, der die gleiche Syntax wie der Befehl zrangebyscore verwendet. Das folgende Beispiel entfernt jedes in faveGuitarists enthaltene Mitglied mit einem Score von 4, 5 oder 6:

      • zremrangebyscore faveGuitarists 4 6

      Output

      (integer) 1

      Sie können Mitglieder aus einem Set auf der Grundlage eines Rangbereichs mit dem Befehl zremrangebyrank entfernen, der die gleiche Syntax wie zrangebyrank verwendet. Der folgende Befehl entfernt die drei Mitglieder des sortierten Sets mit den niedrigsten Rängen, die durch einen Bereich von nullbasierten Indizes definiert sind:

      • zremrangebyrank faveGuitarists 0 2

      Output

      (integer) 3

      Beachten Sie, dass an remrangebyrank übergebene Zahlen auch negativ sein können, wobei -1 den höchsten Rang repräsentiert, -2 den nächsthöheren, und so fort.

      Erstellen von neuen sortierten Sets aus bestehenden Sets

      Redis enthält zwei Befehle, die es Ihnen ermöglichen, Mitglieder mehrerer sortierter Sets zu vergleichen und auf der Grundlage dieser Vergleiche neue Sets zu erstellen: zinterstore und zunionstore. Um diese Befehle auszuprobieren, führen Sie die folgenden zadd-Befehle aus, um einige sortierte Beispielsets zu erstellen.

      • zadd NewKids 1 "Jonathan" 2 "Jordan" 3 "Joey" 4 "Donnie" 5 "Danny"
      • zadd Nsync 1 "Justin" 2 "Chris" 3 "Joey" 4 "Lance" 5 "JC"

      zinterstore findet die Mitglieder, die von zwei oder mehreren sortierten Sets geteilt werden – deren Schnittmenge – und erzeugt ein neues sortiertes Set, das nur diese Mitglieder enthält. Dieser Befehl muss den Namen eines Zielschlüssels, in dem die sich überschneidenden Mitglieder als sortiertes Set gespeichert werden, die Anzahl der an zinterstore übergebenden Schlüssel und die Namen der Schlüssel, die Sie analysieren möchten, in der Reihenfolge enthalten:

      • zinterstore BoyBands 2 NewKids Nsync

      zinterstore gibt dann eine ganze Zahl aus, die die Anzahl der im sortierten Zielset gespeicherten Elemente anzeigt. Da NewKids und Nsync nur ein Mitglied teilen – "Joey"– gibt der Befehl 1 aus:

      Output

      (integer) 1

      Bitte beachten Sie: Falls der Zielschlüssel bereits existiert, überschreibt zinterstore dessen Inhalt.

      zunionstore erstellt ein neues sortiertes Set, das jedes Mitglied der an den Befehl übergebenen Schlüssel enthält. Dieser Befehl verwendet die gleiche Syntax wie zinterstore und erfordert den Namen eines Zielschlüssels, die Anzahl der an den Befehl übergebenen Schlüssel und die Namen der Schlüssel:

      • zunionstore SuperGroup 2 NewKids Nsync

      Wie zinterstore gibt zunionstore eine ganze Zahl aus, die die Anzahl der im Zielschlüssel gespeicherten Elemente anzeigt. Obwohl beide der ursprünglich sortierten Sets fünf Mitglieder enthalten, die sortierten Sets jedoch keine sich wiederholenden Mitglieder enthalten können und jeder Schlüssel ein Mitglied mit dem Namen "Joey" beinhaltet, ist die resultierende ganze Zahl 9:

      Output

      (integer) 9

      Wie zinterstore überschreibt zunionstore den Inhalt des Zielschlüssels, wenn dieser bereits existiert.

      Um Ihnen beim Erstellen von neuen sortierten Sets mit zinterstore und zunionstore mehr Kontrolle über die Scores der Mitglieder zu geben, akzeptieren beide Befehle die Optionen WEIGHTS und AGGREGATE.

      Auf die Option WEIGHTS folgt eine Zahl für jedes im Befehl enthaltene sortierte Set, welche die Scores jedes Mitglieds bewertet oder vervielfacht. Die erste Zahl nach der Option WEIGHTS bewertet die Scores des ersten an den Befehl übergebenen Schlüssels, die zweite Zahl den zweiten Schlüssel, und so fort.

      Das folgende Beispiel erstellt ein neues sortiertes Set, das die überschneidenden Schlüssel aus den sortierten Sets NewKids und Nsync enthält. Es bewertet die Scores im Schlüssel NewKids mit dem Faktor drei und die im Schlüssel Nsync mit dem Faktor sieben:

      • zinterstore BoyBandsWeighted 2 NewKids Nsync WEIGHTS 3 7

      Wenn die Option WEIGHTS nicht enthalten ist, wird die Bewertung standardmäßig auf 1 gesetzt, sowohl für zinterstore als auch für zunionstore.

      AGGREGATE akzeptiert drei Suboptionen. Die erste davon, SUM, implementiert das Standardverhalten von zinterstore und zunionstore, indem sie die Scores von übereinstimmenden Mitgliedern den kombinierten Sets hinzufügt.

      Wenn Sie in zwei sortierten Sets, die ein Mitglied teilen, eine zinterstore– oder zunionstore-Operation ausführen, dieses Mitglied aber in jedem Set einen anderen Score hat, können Sie die Operation mit der Suboption MIN zwingen, den niedrigeren der beiden Punktstände zuzuweisen.

      • zinterstore BoyBandsWeightedMin 2 NewKids Nsync WEIGHTS 3 7 AGGREGATE MIN

      Da die beiden sortierten Sets nur ein übereinstimmendes Mitglied mit dem gleichen Score (3) haben, erstellt dieser Befehl ein neues Set mit einem Mitglied, das den niedrigeren der beiden bewerteten Scores hat:

      • zscore BoyBandsWeightedMin "Joey"

      Output

      "9"

      Ebenso kann AGGREGATE zinterstore oder zunionstore zwingen, mit der Option MAX den höheren der beiden Scores zuzuweisen:

      • zinterstore BoyBandsWeightedMax 2 NewKids Nsync WEIGHTS 3 7 AGGREGATE MAX

      Dieser Befehl erstellt ein neues Set mit einem Mitglied, "Joey", das den höheren der beiden bewerteten Scores hat:

      • zscore BoyBandsWeightedMax "Joey"

      Output

      "21"

      Es kann hilfreich sein, sich WEIGHTS als eine Möglichkeit vorzustellen, die Scores von Mitgliedern vorübergehend zu manipulieren, bevor sie analysiert werden. Ebenso ist es hilfreich, sich die Option AGGREGATE als Entscheidungsmöglichkeit vorzustellen, wie die Scores der Mitglieder kontrolliert werden können, bevor sie in ihre neuen Sets aufgenommen werden.

      Zusammenfassung

      Dieser Leitfaden erläutert eine Reihe von Befehlen, die zur Erstellung und Verwaltung von sortierten Sets in Redis verwendet werden. Wenn es andere verwandte Befehle, Argumente oder Verfahren gibt, die Sie in diesem Leitfaden erklärt sehen möchten, schreiben Sie bitte eine Frage oder einen Vorschlag in das Kommentarfeld unten.

      Weitere Informationen zu Redis finden Sie in unserer Tutorialserie Verwalten einer Redis-Datenbank.



      Source link

      Comment gérer les sets triés dans Redis


      Introduction

      Redis est un magasin open source de données clé-valeur en mémoire. Dans Redis, les sets triés sont un type de données semblable aux sets, en ce sens qu’ils sont tous deux des groupes de chaînes non répétitifs. La différence est que chaque membre d’un set trié est associé à un score, ce qui permet de les trier du plus petit score au plus grand. Comme pour les sets, chaque membre d’un set trié doit être unique, même si plusieurs membres peuvent partager le même score.

      Ce tutoriel explique comment créer des sets triés, récupérer et supprimer leurs membres, et créer de nouveaux sets triés à partir de ceux qui existent déjà.

      Ce guide est rédigé sous la forme d’une fiche avec des exemples autonomes. Nous vous encourageons à passer directement à la section qui correspond à la tâche que vous essayez d’accomplir.

      Les commandes présentées dans ce guide ont été testées sur un serveur Ubuntu 18.04 exécutant la version 4.0.9 de Redis. Pour mettre en place un environnement similaire, vous pouvez suivre l’étape 1 de notre guide Comment installer et sécuriser Redis sur Ubuntu 18.04. Nous montrerons comment ces commandes se comportent en les exécutant avec redis-cli, l’interface en ligne de commande Redis. Notez que si vous utilisez une autre interface Redis, Redli par exemple, la sortie exacte de certaines commandes peut différer.

      Vous pouvez également provisionner une instance de base de données Redis gérée pour tester ces commandes, mais notez que selon le niveau de contrôle autorisé par votre fournisseur de base de données, certaines commandes de ce guide peuvent ne pas fonctionner comme décrit. Pour provisionner une base de données gérée DigitalOcean, suivez la documentation de notre produit Managed Databases. Ensuite, vous devez soit installer Redli, soit mettre en place un tunnel TLS afin de vous connecter à la base de données gérée via TLS.

      Création de sets triés et ajout de membres

      Pour créer un set trié, utilisez la commande zadd. zadd accepte comme arguments le nom de la clé qui contiendra le set trié, suivi du score du membre que vous ajoutez et de la valeur du membre lui-même. La commande suivante va créer une clé de set trié appelée faveGuitarists avec un membre, "Joe Pass", qui a un score de 1 :

      • zadd faveGuitarists 1 "Joe Pass"

      zadd renverra un entier indiquant combien de membres ont été ajoutés au set trié s’il a été créé avec succès.

      Output

      (integer) 1

      Vous pouvez ajouter plus d’un membre à un set trié avec zadd. Notez que leurs scores n’ont pas besoin d’être séquentiels, il peut y avoir des écarts entre les scores, et plusieurs membres détenus dans un même set trié peuvent partager le même score :

      • zadd faveGuitarists 4 "Stephen Malkmus" 2 "Rosetta Tharpe" 3 "Bola Sete" 3 "Doug Martsch" 8 "Elizabeth Cotten" 12 "Nancy Wilson" 4 "Memphis Minnie" 12 "Michael Houser"

      Output

      (integer) 8

      zadd peut accepter les options suivantes, que vous devez saisir après le nom de la clé et avant le premier score de membre :

      • NX ou XX : ces options ont des effets opposés, de sorte que vous ne pouvez en inclure qu’une seule dans toute opération zadd :
        • NX : dit à zadd de ne pas mettre à jour les membres existants. Avec cette option, zadd ne fera qu’ajouter de nouveaux éléments.
        • XX : dit à zadd de seulement mettre à jour les éléments existants. Avec cette option, zadd n’ajoutera jamais de nouveaux membres.
      • CH : normalement, zadd ne renvoie que le nombre de nouveaux éléments ajoutés au set trié. Cependant, si cette option est incluse, zadd renvoie le nombre d’éléments modifiés. Cela inclut les membres nouvellement ajoutés et les membres dont les scores ont été modifiés.
      • INCR : avec cette option, la commande incrémente la valeur du score du membre. Si le membre n’existe pas encore, la commande l’ajoutera au set trié avec l’incrément comme score, comme si son score initial était de 0. Avec INCR inclus, zadd retournera le nouveau score du membre si la commande est réussie. Notez que vous ne pouvez inclure qu’une seule paire score/membre à la fois lorsque vous utilisez cette option.

      Au lieu de passer l’option INCR à zadd, vous pouvez utiliser la commande zincrby qui se comporte exactement de la même manière. Au lieu de donner au membre du set trié la valeur indiquée par la valeur du score comme zadd, elle incrémente le score de ce membre de cette valeur. Par exemple, la commande suivante augmente de 5 le score du membre "Stephen Malkmus", qui passe alors de 4 à 9.

      • zincrby faveGuitarists 5 "Stephen Malkmus"

      Output

      "9"

      Comme c’est le cas avec l’option INCR de la commande zadd, si le membre spécifié n’existe pas, zincrby le créera avec la valeur d’incrément comme score.

      La façon la plus simple de récupérer les membres détenus dans un set trié est d’utiliser la commande zrange. Cette commande accepte comme arguments le nom de la clé dont vous voulez récupérer les membres et une série de membres détenus en son sein. La plage est définie par deux nombres qui représentent des indices basés sur zéro, ce qui signifie que 0 représente le premier membre du set trié (ou le membre ayant le score le plus bas), 1 représente le suivant, et ainsi de suite.

      L’exemple suivant renvoie les quatre premiers membres du set trié faveGuitarists créé dans la section précédente :

      • zrange faveGuitarists 0 3

      Output

      1) "Joe Pass" 2) "Rosetta Tharpe" 3) "Bola Sete" 4) "Doug Martsch"

      Notez que si le set trié que vous passez à zrange comporte deux éléments ou plus qui partagent le même score, il triera ces éléments dans l’ordre lexicographique, ou alphabétique.

      Les indices de départ et d’arrêt peuvent également être des nombres négatifs, avec -1 représentant le dernier membre, -2 l’avant-dernier, etc. :

      • zrange faveGuitarists -5 -2

      Output

      1) "Memphis Minnie" 2) "Elizabeth Cotten" 3) "Stephen Malkmus" 4) "Michael Houser"

      zrange peut accepter l’argument WITHSCORES qui, une fois inclus, rendra également les scores des membres :

      • zrange faveGuitarists 5 6 WITHSCORES

      Output

      1) "Elizabeth Cotten" 2) "8" 3) "Stephen Malkmus" 4) "9"

      zrange ne peut renvoyer une série de membres que dans l’ordre numérique croissant. Pour inverser cela et renvoyer une plage par ordre décroissant, vous devez utiliser la commande zrevrange. Considérez cette commande comme une inversion temporaire de l’ordre du set trié donné avant de renvoyer les membres qui se trouvent dans la plage spécifiée. Ainsi, avec zrevrange, 0 représentera le dernier membre détenu dans la clé, 1 représentera l’avant-dernier, et ainsi de suite :

      • zrevrange faveGuitarists 0 5

      Output

      1) "Nancy Wilson" 2) "Michael Houser" 3) "Stephen Malkmus" 4) "Elizabeth Cotten" 5) "Memphis Minnie" 6) "Doug Martsch"

      zrevrange peut également accepter l’option WITHSCORES.

      Vous pouvez renvoyer une série de membres en fonction de leurs scores avec la commande zrangebyscore. Dans l’exemple suivant, la commande renverra tout membre détenu dans la clé faveGuitarists avec un score de 2, 3 ou 4 :

      • zrangebyscore faveGuitarists 2 4

      Output

      1) "Rosetta Tharpe" 2) "Bola Sete" 3) "Doug Martsch" 4) "Memphis Minnie"

      Dans cet exemple, la fourchette est inclusive, ce qui signifie qu’elle renvoie les membres ayant un score de 2 ou 4. Vous pouvez exclure l’une ou l’autre des extrémités de la plage en la faisant précéder d’une parenthèse ouverte ((). Dans l’exemple suivant, la commande renverra chaque membre dont le score est supérieur ou égal à 2, mais inférieur à 4 :

      • zrangebyscore faveGuitarists 2 (4

      Output

      1) "Rosetta Tharpe" 2) "Bola Sete" 3) "Doug Martsch"

      Comme pour zrange, zrangebyscore peut accepter l’argument WITHSCORES. La commande accepte également l’option LIMIT, que vous pouvez utiliser pour ne récupérer qu’une sélection d’éléments de la sortie zrangebyscore. Cette option accepte un décalage, qui marque le premier membre de la plage que la commande retournera, et un comptage, qui définit combien de membres la commande retournera au total. Par exemple, la commande suivante examinera les six premiers membres du set trié faveGuitarists mais n’en renverra que trois, à partir du deuxième membre du set, représenté par 1 :

      • zrangebyscore faveGuitarists 0 5 LIMIT 1 3

      Output

      1) "Rosetta Tharpe" 2) "Bola Sete" 3) "Doug Martsch"

      La commande zrevrangebyscore renvoie une plage inversée de membres en fonction de leurs scores. La commande suivante renvoie chaque membre du set avec un score compris entre 10 et 6 :

      • zrevrangebyscore faveGuitarists 10 6

      Output

      1) "Stephen Malkmus" 2) "Elizabeth Cotten"

      Comme pour zrangebyscore, zrevrangebyscore peut accepter à la fois les options WITHSCORES et LIMIT. De plus, vous pouvez exclure l’une ou l’autre extrémité de la plage en la faisant précéder d’une parenthèse ouverte.

      Il peut arriver que tous les membres d’un set trié aient le même score. Dans ce cas, vous pouvez forcer redis à renvoyer une série d’éléments triés lexicographiquement, ou par ordre alphabétique, avec la commande zrangebylex. Pour essayer cette commande, lancez la commande zadd suivante pour créer un set trié où chaque membre a le même score :

      • zadd SomervilleSquares 0 Davis 0 Inman 0 Union 0 porter 0 magoun 0 ball 0 assembly

      zrangebylex doit être suivi du nom d’une clé, d’un intervalle de démarrage et d’un intervalle d’arrêt. Les intervalles de démarrage et d’arrêt doivent commencer par une parenthèse ouverte (() ou une accolade ouverte ([), comme ceci :

      • zrangebylex SomervilleSquares [a [z

      Output

      1) "assembly" 2) "ball" 3) "magoun" 4) "porter"

      Notez que cet exemple n’a renvoyé que quatre des huit membres du set, même si la commande recherchait une plage de a à z. Cela s’explique par le fait que les valeurs Redis sont sensibles à la casse, de sorte que les membres qui commencent par des lettres majuscules ont été exclus de sa sortie. Pour les restituer, vous pouvez procéder comme suit :

      • zrangebylex SomervilleSquares [A [z

      Output

      1) "Davis" 2) "Inman" 3) "Union" 4) "assembly" 5) "ball" 6) "magoun" 7) "porter"

      zrangebylex accepte également les caractères spéciaux -, qui représente l’infini négatif, et +, qui représente l’infini positif. Ainsi, la syntaxe de commande suivante renverra également chaque membre du set trié :

      • zrangebylex SomervilleSquares - +

      Notez que zrangebylex ne peut pas renvoyer les membres d’un set trié dans l’ordre lexicographique inverse (ordre alphabétique croissant). Pour ce faire, utilisez zrevrangebylex :

      • zrevrangebylex SomervilleSquares + -

      Output

      1) "porter" 2) "magoun" 3) "ball" 4) "assembly" 5) "Union" 6) "Inman" 7) "Davis"

      Comme cette commande est destinée à l’utilisation avec les sets triés où chaque membre a le même score, zrangebylex n’accepte pas l’option WITHSCORES. Elle accepte toutefois l’option LIMIT.

      Pour savoir combien de membres se trouvent dans un set trié donné (ou, en d’autres termes, pour déterminer sa cardinalité), utilisez la commande zcard. L’exemple suivant montre combien de membres sont détenus dans la clé faveGuitarists de la première section de ce guide :

      Output

      (integer) 9

      zcount peut vous dire combien d’éléments conservés dans un set trié se situent dans une plage de scores. Le premier chiffre qui suit la clé est le début de la plage et le second est la fin de la plage :

      • zcount faveGuitarists 3 8

      Output

      (integer) 4

      zscore renvoie le score d’un membre spécifique d’un set trié :

      • zscore faveGuitarists "Bola Sete"

      Output

      "3"

      Si la clé ou le membre spécifié n’existe pas, zscore retournera (nil).

      zrank est semblable à zscore, mais au lieu de renvoyer le score du membre donné, il renvoie son rang. Dans Redis, un rang est un indice basé sur zéro des membres d’un set trié, ordonné par leur score. Par exemple, "Joe Pass" a un score de 1, mais comme c’est le score le plus bas de tous les membres de la clé, il a un rang de 0 :

      • zrank faveGuitarists "Joe Pass"

      Output

      (integer) 0

      Il existe une autre commande Redis appelé zrevrank qui remplit la même fonction que zrank, mais qui inverse les rangs des membres du set. Dans l’exemple suivant, le membre "Joe Pass" a le score le plus bas, et par conséquent le rang inversé le plus élevé :

      • zrevrank faveGuitarists "Joe Pass"

      Output

      (integer) 8

      La seule relation entre le score d’un membre et son rang est la position de son score par rapport à ceux des autres membres. S’il y a un écart de score entre deux membres successifs, cela ne se reflétera pas dans leur rang. Notez que si deux membres ont le même score, celui qui vient en premier dans l’ordre alphabétique aura le rang le plus bas.

      Comme zscore, zrank et zrevrank retourneront (nil) si la clé ou le membre n’existe pas.

      zlexcount peut vous dire combien de membres d’un set trié sont contenus dans une plage lexicographique. L’exemple suivant utilise le set trié SomervilleSquares de la section précédente :

      • zlexcount SomervilleSquares [M [t

      Output

      (integer) 5

      Cette commande suit la même syntaxe que la commande zrangebylex, reportez-vous donc à la section précédente pour savoir comment définir une plage de chaînes.

      Suppression de membres des sets triés

      La commande zrem permet de supprimer un ou plusieurs membres d’un set trié :

      • zrem faveGuitarists "Doug Martsch" "Bola Sete"

      zrem renverra un nombre entier indiquant combien de membres ont été retirés du set trié :

      Output

      (integer) 2

      Il existe trois commandes Redis qui vous permettent de supprimer les membres d’un set trié en fonction d’une plage. Par exemple, si chaque membre d’un set trié a le même score, vous pouvez supprimer des membres sur la base d’une plage lexicographique avec zremrangebylex. Cette commande utilise la même syntaxe que zrangebylex. L’exemple suivant permet de supprimer tout membre commençant par une majuscule de la clé SomervilleSquares créée dans la section précédente :

      • zremrangebylex SomervilleSquares [A [Z

      La commande zremrangebylex affichera un nombre entier indiquant le nombre de membres qu’elle a retirés :

      Output

      (integer) 3

      Vous pouvez également supprimer des membres sur la base d’une plage de scores avec la commande zremrangebyscore, qui utilise la même syntaxe que la commande zrangebyscore. L’exemple suivant permettra de supprimer tout membre détenu dans faveGuitarists avec un score de 4, 5 ou 6 :

      • zremrangebyscore faveGuitarists 4 6

      Output

      (integer) 1

      Vous pouvez retirer des membres d’un set basé sur une plage de rangs avec la commande zremrangebyrank, qui utilise la même syntaxe que zrangebyrank. La commande suivante supprimera les trois membres du set trié ayant les rangs les plus bas, qui sont définis par une série d’indices basés sur zéro :

      • zremrangebyrank faveGuitarists 0 2

      Output

      (integer) 3

      Notez que les chiffres transmis à remrangebyrank peuvent également être négatifs, avec -1 représentant le rang le plus élevé, -2 le rang suivant, et ainsi de suite.

      Création de nouveaux sets triés à partir de sets existants

      Redis comprend deux commandes qui vous permettent de comparer les membres de plusieurs sets triés et d’en créer de nouveaux sur la base de ces comparaisons : zinterstore et zunionstore. Pour expérimenter ces commandes, exécutez les commandes zadd suivantes pour créer des exemples de sets triés.

      • zadd NewKids 1 "Jonathan" 2 "Jordan" 3 "Joey" 4 "Donnie" 5 "Danny"
      • zadd Nsync 1 "Justin" 2 "Chris" 3 "Joey" 4 "Lance" 5 "JC"

      zinterstore trouve les membres partagés par deux ou plusieurs sets triés (leur intersection) et produit un nouveau set trié contenant uniquement ces membres. Cette commande doit inclure, dans l’ordre, le nom d’une clé de destination où les membres croisés seront stockés en tant que set trié, le nombre de clés transmises à zinterstore, et les noms des clés que vous voulez analyser :

      • zinterstore BoyBands 2 NewKids Nsync

      zinterstore renvoie un nombre entier indiquant le nombre d’éléments stockés dans le set trié de destination. Comme NewKids et Nsync ne partagent qu’un seul membre, "Joey", la commande renverra 1 :

      Output

      (integer) 1

      Sachez que si la clé de destination existe déjà, zinterstore écrasera son contenu.

      zunionstore va créer un nouveau set trié contenant tous les membres des clés qui lui ont été transmises. Cette commande utilise la même syntaxe que zinterstore, et nécessite le nom d’une clé de destination, le nombre de clés transmises à la commande et les noms des clés :

      • zunionstore SuperGroup 2 NewKids Nsync

      Comme zinterstore, zunionstore renvoie un nombre entier indiquant le nombre d’éléments stockés dans la clé de destination. Même si les deux sets triés originaux contenaient chacun cinq membres, puisque les sets triés ne peuvent pas avoir de membres répétés et que chaque clé a un membre nommé "Joey", l’entier résultant sera 9 :

      Output

      (integer) 9

      Comme zinterstore, zunionstore écrasera le contenu de la clé de destination si elle existe déjà.

      Pour vous donner plus de contrôle sur les scores des membres lors de la création de nouveaux sets triés avec zinterstore et zunionstore, ces deux commandes acceptent les options WEIGHTS et AGGREGATE.

      L’option WEIGHTS est suivie d’un chiffre pour chaque set trié inclus dans la commande qui pondère, ou multiplie, les scores de chaque membre. Le premier chiffre après l’option WEIGHTS pondère les scores de la première clé passée à la commande, le deuxième chiffre pondère la deuxième clé, et ainsi de suite.

      L’exemple suivant crée un nouveau set trié contenant les clés croisées des sets triés NewKids et Nsync. Il pondère les scores dans la clé NewKids par un facteur de trois, et pondère ceux dans la clé Nsync par un facteur de sept :

      • zinterstore BoyBandsWeighted 2 NewKids Nsync WEIGHTS 3 7

      Si l’option WEIGHTS n’est pas incluse, la pondération est par défaut de 1 pour zinterstore et zunionstore.

      AGGREGATE accepte trois sous-options. La première d’entre elles, SUM, implémente le comportement par défaut de zinterstore et zunionstore en ajoutant les scores des membres correspondants dans les sets combinés.

      Si vous exécutez une opération zinterstore ou zunionstore sur deux sets triés qui partagent un membre, mais que ce membre a un score différent dans chaque set, vous pouvez forcer l’opération à attribuer le plus bas des deux scores dans le nouveau set avec la sous-option MIN.

      • zinterstore BoyBandsWeightedMin 2 NewKids Nsync WEIGHTS 3 7 AGGREGATE MIN

      Comme les deux sets triés n’ont qu’un seul membre correspondant avec le même score (3), cette commande va créer un nouveau set avec un membre qui a le plus bas des deux scores pondérés :

      • zscore BoyBandsWeightedMin "Joey"

      Output

      "9"

      De même, AGGREGATE peut forcer zinterstore ou zunionstore à attribuer le score le plus élevé des deux avec l’option MAX :

      • zinterstore BoyBandsWeightedMax 2 NewKids Nsync WEIGHTS 3 7 AGGREGATE MAX

      Cette commande crée un nouveau set avec un membre, "Joey", qui a le plus haut des deux scores pondérés :

      • zscore BoyBandsWeightedMax "Joey"

      Output

      "21"

      Il peut être utile de considérer WEIGHTS comme un moyen de manipuler temporairement les scores des membres avant qu’ils ne soient analysés. De même, il est utile de considérer l’option AGGREGATE comme un moyen de décider comment contrôler les scores des membres avant qu’ils ne soient ajoutés à leurs nouveaux sets.

      Conclusion

      Ce guide détaille un certain nombre de commandes utilisées pour créer et gérer des sets triés dans Redis. S’il y a d’autres commandes, arguments ou procédures connexes que vous aimeriez voir décrits dans ce guide, n’hésitez pas à faire des suggestions dans les commentaires ci-dessous.

      Pour plus d’informations sur les commandes Redis, consultez notre série de tutoriels Comment gérer une base de données Redis.



      Source link

      How To Manage Sorted Sets in Redis


      Introduction

      Redis is an open-source, in-memory key-value data store. In Redis, sorted sets are a data type similar to sets in that both are non repeating groups of strings. The difference is that each member of a sorted set is associated with a score, allowing them to be sorted from the smallest score to the largest. As with sets, every member of a sorted set must be unique, though multiple members can share the same score.

      This tutorial explains how to create sorted sets, retrieve and remove their members, and create new sorted sets from existing ones.

      How To Use This Guide

      This guide is written as a cheat sheet with self-contained examples. We encourage you to jump to any section that is relevant to the task you’re trying to complete.

      The commands shown in this guide were tested on an Ubuntu 18.04 server running Redis version 4.0.9. To set up a similar environment, you can follow Step 1 of our guide on How To Install and Secure Redis on Ubuntu 18.04. We will demonstrate how these commands behave by running them with redis-cli, the Redis command line interface. Note that if you’re using a different Redis interface — Redli, for example — the exact output of certain commands may differ.

      Alternatively, you could provision a managed Redis database instance to test these commands, but note that depending on the level of control allowed by your database provider, some commands in this guide may not work as described. To provision a DigitalOcean Managed Database, follow our Managed Databases product documentation. Then, you must either install Redli or set up a TLS tunnel in order to connect to the Managed Database over TLS.

      Creating Sorted Sets and Adding Members

      To create a sorted set, use the zadd command. zadd accepts as arguments the name of the key that will hold the sorted set, followed by the score of the member you’re adding and the value of the member itself. The following command will create a sorted set key named faveGuitarists with one member, "Joe Pass", that has a score of 1:

      • zadd faveGuitarists 1 "Joe Pass"

      zadd will return an integer that indicates how many members were added to the sorted set if it was created successfully.

      Output

      (integer) 1

      You can add more than one member to a sorted set with zadd. Note that their scores don’t need to be sequential, there can be gaps between scores, and multiple members held in the same sorted set can share the same score:

      • zadd faveGuitarists 4 "Stephen Malkmus" 2 "Rosetta Tharpe" 3 "Bola Sete" 3 "Doug Martsch" 8 "Elizabeth Cotten" 12 "Nancy Wilson" 4 "Memphis Minnie" 12 "Michael Houser"

      Output

      (integer) 8

      zadd can accept the following options, which you must enter after the key name and before the first member score:

      • NX or XX: These options have opposite effects, so you can only include one of them in any zadd operation:
        • NX: Tells zadd not to update existing members. With this option, zadd will only add new elements.
        • XX: Tells zadd to only update existing elements. With this option, zadd will never add new members.
      • CH: Normally, zadd only returns the number of new elements added to the sorted set. With this option included, though, zadd will return the number changed elements. This includes newly added members and members whose scores were changed.
      • INCR: This causes the command to increment the member’s score value. If the member doesn’t yet exist, the command will add it to the sorted set with the increment as its score, as if its original score was 0. With INCR included, the zadd will return the member’s new score if it’s successful. Note that you can only include one score/member pair at a time when using this option.

      Instead of passing the INCR option to zadd, you can instead use the zincrby command which behaves the exact same way. Instead of giving the sorted set member the value indicated by the score value like zadd, it increments that member’s score up by that value. For example, the following command increments the score of the member "Stephen Malkmus", which was originally 4, up by 5 to 9.

      • zincrby faveGuitarists 5 "Stephen Malkmus"

      Output

      "9"

      As is the case with the zadd command’s INCR option, if the specified member doesn’t exist then zincrby will create it with the increment value as its score.

      Retrieving Members from Sorted Sets

      The most fundamental way to retrieve the members held within a sorted set is to use the zrange command. This command accepts as arguments the name of the key whose members you want to retrieve and a range of members held within it. The range is defined by two numbers that represent zero-based indexes, meaning that 0 represents the first member in the sorted set (or, the member with the lowest score), 1 represents the next, and so on.

      The following example will return the first four members from the faveGuitarists sorted set created in the previous section:

      • zrange faveGuitarists 0 3

      Output

      1) "Joe Pass" 2) "Rosetta Tharpe" 3) "Bola Sete" 4) "Doug Martsch"

      Note that if the sorted set you pass to zrange has two or more elements that share the same score, it will sort those elements in lexicographical, or alphabetical, order.

      The start and stop indexes can also be negative numbers, with -1 representing the last member, -2 representing the second to last, and so on:

      • zrange faveGuitarists -5 -2

      Output

      1) "Memphis Minnie" 2) "Elizabeth Cotten" 3) "Stephen Malkmus" 4) "Michael Houser"

      zrange can accept the WITHSCORES argument which, when included, will also return the members’ scores:

      • zrange faveGuitarists 5 6 WITHSCORES

      Output

      1) "Elizabeth Cotten" 2) "8" 3) "Stephen Malkmus" 4) "9"

      zrange can only return a range of members in ascending numerical order. To reverse this and return a range in descending order, you must use the zrevrange command. Think of this command as temporarily reversing the order of the given sorted set before returning the members that fall within the specified range. So with zrevrange, 0 will represent the last member held in the key, 1 will represent the second to last, and so on:

      • zrevrange faveGuitarists 0 5

      Output

      1) "Nancy Wilson" 2) "Michael Houser" 3) "Stephen Malkmus" 4) "Elizabeth Cotten" 5) "Memphis Minnie" 6) "Doug Martsch"

      zrevrange can also accept the WITHSCORES option.

      You can return a range of members based on their scores with the zrangebyscore command. In the following example, the command will return any member held in the faveGuitarists key with a score of 2, 3, or 4:

      • zrangebyscore faveGuitarists 2 4

      Output

      1) "Rosetta Tharpe" 2) "Bola Sete" 3) "Doug Martsch" 4) "Memphis Minnie"

      The range is inclusive in this example, meaning that it will return members with scores of 2 or 4. You can exclude either end of the range by preceding it with an open parenthesis ((). The following example will return every member with a score greater than or equal to 2, but less than 4:

      • zrangebyscore faveGuitarists 2 (4

      Output

      1) "Rosetta Tharpe" 2) "Bola Sete" 3) "Doug Martsch"

      As with zrange, zrangebyscore can accept the WITHSCORES argument. It also accepts the LIMIT option, which you can use to retrieve only a selection of elements from the zrangebyscore output. This option accepts an offset, which marks the first member in the range that the command will return, and a count, which defines how many members the command will return in total. For example, the following command will look at the first six members of the faveGuitarists sorted set but will only return 3 members from it, starting from the second member in the range, represented by 1:

      • zrangebyscore faveGuitarists 0 5 LIMIT 1 3

      Output

      1) "Rosetta Tharpe" 2) "Bola Sete" 3) "Doug Martsch"

      The zrevrangebyscore command returns a reversed range of members based on their scores. The following command returns every member of the set with a score between 10 and 6:

      • zrevrangebyscore faveGuitarists 10 6

      Output

      1) "Stephen Malkmus" 2) "Elizabeth Cotten"

      As with zrangebyscore, zrevrangebyscore can accept both the WITHSCORES and LIMIT options. Additionally, you can exclude either end of the range by preceding it with an open parenthesis.

      There may be times when all the members in a sorted set have the same score. In such a case, you can force redis to return a range of elements sorted lexicographically, or in alphabetical order, with the zrangebylex command. To try out this command, run the following zadd command to create a sorted set where each member has the same score:

      • zadd SomervilleSquares 0 Davis 0 Inman 0 Union 0 porter 0 magoun 0 ball 0 assembly

      zrangebylex must be followed by the name of a key, a start interval, and a stop interval. The start and stop intervals must begin with an open parenthesis (() or an open bracket ([), like this:

      • zrangebylex SomervilleSquares [a [z

      Output

      1) "assembly" 2) "ball" 3) "magoun" 4) "porter"

      Notice that this example returned only four of the eight members in the set, even though the command sought a range from a to z. This is because Redis values are case-sensitive, so the members that begin with uppercase letters were excluded from its output. To return those, you could run the following:

      • zrangebylex SomervilleSquares [A [z

      Output

      1) "Davis" 2) "Inman" 3) "Union" 4) "assembly" 5) "ball" 6) "magoun" 7) "porter"

      zrangebylex also accepts the special characters -, which represents negative infinity, and +, which represents positive infinity. Thus, the following command syntax will also return every member of the sorted set:

      • zrangebylex SomervilleSquares - +

      Note that zrangebylex cannot return sorted set members in reverse lexicographical (ascending alphabetical) order. To do that, use zrevrangebylex:

      • zrevrangebylex SomervilleSquares + -

      Output

      1) "porter" 2) "magoun" 3) "ball" 4) "assembly" 5) "Union" 6) "Inman" 7) "Davis"

      Because it’s intended for use with sorted sets where every member has the same score, zrangebylex does not accept the WITHSCORES option. It does, however, accept the LIMIT option.

      Retrieving Information about Sorted Sets

      To find out how many members are in a given sorted set (or, in other words, to determine its cardinality), use the zcard command. The following example shows how many members are held in the faveGuitarists key from the first section of this guide:

      Output

      (integer) 9

      zcount can tell you how many elements are held within a given sorted set that fall within a range of scores. The first number following the key is the start of the range and the second one is the end of the range:

      • zcount faveGuitarists 3 8

      Output

      (integer) 4

      zscore outputs the score of a specified member of a sorted set:

      • zscore faveGuitarists "Bola Sete"

      Output

      "3"

      If either the specified member or key don’t exist, zscore will return (nil).

      zrank is similar to zscore, but instead of returning the given member’s score, it instead returns its rank. In Redis, a rank is a zero-based index of the members of a sorted set, ordered by their score. For example, "Joe Pass" has a score of 1, but because that is the lowest score of any member in the key, it has a rank of 0:

      • zrank faveGuitarists "Joe Pass"

      Output

      (integer) 0

      There’s another Redis command called zrevrank which performs the same function as zrank, but instead reverses the ranks of the members in the set. In the following example, the member "Joe Pass" has the lowest score, and consequently has the highest reversed rank:

      • zrevrank faveGuitarists "Joe Pass"

      Output

      (integer) 8

      The only relation between a member’s score and their rank is where their score stands in relation to those of other members. If there is a score gap between two sequential members, that won’t be reflected in their rank. Note that if two members have the same score, the one that comes first alphabetically will have the lower rank.

      Like zscore, zrank and zrevrank will return (nil) if the key or member doesn’t exist.

      zlexcount can tell you how many members are held in a sorted set between a lexicographical range. The following example uses the SomervilleSquares sorted set from the previous section:

      • zlexcount SomervilleSquares [M [t

      Output

      (integer) 5

      This command follows the same syntax as the zrangebylex command, so refer to the previous section for details on how to define a string range.

      Removing Members from Sorted Sets

      The zrem command can remove one or more members from a sorted set:

      • zrem faveGuitarists "Doug Martsch" "Bola Sete"

      zrem will return an integer indicating how many members it removed from the sorted set:

      Output

      (integer) 2

      There are three Redis commands that allow you to remove members of a sorted set based on a range. For example, if each member in a sorted set has the same score, you can remove members based on a lexicographical range with zremrangebylex. This command uses the same syntax as zrangebylex. The following example will remove every member that begins with a capital letter from the SomervilleSquares key created in the previous section:

      • zremrangebylex SomervilleSquares [A [Z

      zremrangebylex will output an integer indicating how many members it removed:

      Output

      (integer) 3

      You can also remove members based on a range of scores with the zremrangebyscore command, which uses the same syntax as the zrangebyscore command. The following example will remove every member held in faveGuitarists with a score of 4, 5, or 6:

      • zremrangebyscore faveGuitarists 4 6

      Output

      (integer) 1

      You can remove members from a set based on a range of ranks with the zremrangebyrank command, which uses the same syntax as zrangebyrank. The following command will remove the three members of the sorted set with the lowest rankings, which are defined by a range of zero-based indexes:

      • zremrangebyrank faveGuitarists 0 2

      Output

      (integer) 3

      Note that numbers passed to remrangebyrank can also be negative, with -1 representing the highest rank, -2 the next highest, and so on.

      Creating New Sorted Sets from Existing Ones

      Redis includes two commands that allow you to compare members of multiple sorted sets and create new ones based on those comparisons: zinterstore and zunionstore. To experiment with these commands, run the following zadd commands to create some example sorted sets.

      • zadd NewKids 1 "Jonathan" 2 "Jordan" 3 "Joey" 4 "Donnie" 5 "Danny"
      • zadd Nsync 1 "Justin" 2 "Chris" 3 "Joey" 4 "Lance" 5 "JC"

      zinterstore finds the members shared by two or more sorted sets — their intersection — and produces a new sorted set containing only those members. This command must include, in order, the name of a destination key where the intersecting members will be stored as a sorted set, the number of keys being passed to zinterstore, and the names of the keys you want to analyze:

      • zinterstore BoyBands 2 NewKids Nsync

      zinterstore will return an integer showing the number of elements stored to the destination sorted set. Because NewKids and Nsync only share one member, "Joey", the command will return 1:

      Output

      (integer) 1

      Be aware that if the destination key already exists, zinterstore will overwrite its contents.

      zunionstore will create a new sorted set holding every member of the keys passed to it. This command uses the same syntax as zinterstore, and requires the name of a destination key, the number of keys being passed to the command, and the names of the keys:

      • zunionstore SuperGroup 2 NewKids Nsync

      Like zinterstore, zunionstore will return an integer showing the number of elements stored in the destination key. Even though both of the original sorted sets held five members, because sorted sets can’t have repeating members and each key has one member named "Joey", the resulting integer will be 9:

      Output

      (integer) 9

      Like zinterstore, zunionstore will overwrite the contents of the destination key if it already exists.

      To give you more control over member scores when creating new sorted sets with zinterstore and zunionstore, both of these commands accept the WEIGHTS and AGGREGATE options.

      The WEIGHTS option is followed by one number for every sorted set included in the command which weight, or multiply, the scores of each member. The first number after the WEIGHTS option weights the scores of the first key passed to the command, the second number weights the second key, and so on.

      The following example creates a new sorted set holding the intersecting keys from the NewKids and Nsync sorted sets. It weights the scores in the NewKids key by a factor of three, and weights those in the Nsync key by a factor of seven:

      • zinterstore BoyBandsWeighted 2 NewKids Nsync WEIGHTS 3 7

      If the WEIGHTS option isn’t included, the weighting defaults to 1 for both zinterstore and zunionstore.

      AGGREGATE accepts three sub-options. The first of these, SUM, implements zinterstore and zunionstore’s default behavior by adding the scores of matching members in the combined sets.

      If you run a zinterstore or zunionstore operation on two sorted sets that share one member, but this member has a different score in each set, you can force the operation to assign the lower of the two scores in the new set with the MIN suboption.

      • zinterstore BoyBandsWeightedMin 2 NewKids Nsync WEIGHTS 3 7 AGGREGATE MIN

      Because the two sorted sets only have one matching member with the same score (3), this command will create a new set with a member that has the lower of the two weighted scores:

      • zscore BoyBandsWeightedMin "Joey"

      Output

      "9"

      Likewise, AGGREGATE can force zinterstore or zunionstore to assign the higher of the two scores with the MAX option:

      • zinterstore BoyBandsWeightedMax 2 NewKids Nsync WEIGHTS 3 7 AGGREGATE MAX

      This command creates a new set with on one member, "Joey", that has the higher of the two weighted scores:

      • zscore BoyBandsWeightedMax "Joey"

      Output

      "21"

      It can be helpful to think of WEIGHTS as a way to temporarily manipulate members’ scores before they’re analyzed. Likewise, it’s helpful to think of the AGGREGATE option as a way to decide how to control members’ scores before they’re added to their new sets.

      Conclusion

      This guide details a number of commands used to create and manage sorted sets in Redis. If there are other related commands, arguments, or procedures you’d like to see outlined in this guide, please ask or make suggestions in the comments below.

      For more information on Redis commands, see our tutorial series on How to Manage a Redis Database.



      Source link