Cláusula join (Referência de C#)

Use a join cláusula para associar elementos de sequências de origem diferentes que não têm nenhuma relação direta no modelo de objeto. O único requisito é que os elementos em cada fonte compartilhem algum valor que você possa comparar quanto à igualdade. Por exemplo, um distribuidor de alimentos pode ter uma lista de fornecedores de um determinado produto e uma lista de compradores. Você pode usar uma join cláusula para criar uma lista dos fornecedores e compradores desse produto que estão todos na mesma região especificada.

A linguagem C# faz referência a documentos da versão mais recentemente lançada da linguagem C#. Ele também contém a documentação inicial para funcionalidades em pré-visualizações públicas para o próximo lançamento do idioma.

A documentação identifica qualquer recurso introduzido pela primeira vez nas três últimas versões do idioma ou nas versões prévias públicas atuais.

Dica

Para descobrir quando um recurso foi introduzido pela primeira vez em C#, consulte o artigo sobre o histórico de versão da linguagem C#.

Uma join cláusula usa duas sequências de origem como entrada. Os elementos em cada sequência devem ser ou conter uma propriedade que você pode comparar a uma propriedade correspondente na outra sequência. A join cláusula usa a palavra-chave especial equals para comparar as chaves especificadas quanto à igualdade. Todas as junções executadas pela join cláusula são equijoins. A forma da saída de uma join cláusula depende do tipo específico de junção que você está executando. A lista a seguir mostra os três tipos de junção mais comuns:

• Junção interna
• Junção de grupo
• Junção externa esquerda

Junção interna

O exemplo a seguir mostra uma junção por igualdade interna simples. Essa consulta produz uma sequência simples de pares de "nome do produto/categoria". A mesma cadeia de caracteres de categoria aparece em vários elementos. Se um elemento de categories não tiver correspondência products, essa categoria não aparecerá nos resultados.

var innerJoinQuery =
    from category in categories
    join prod in products on category.ID equals prod.CategoryID
    select new { ProductName = prod.Name, Category = category.Name }; //produces flat sequence

Para obter mais informações, consulte Executar junções internas.

Junção de grupo

Uma cláusula join com uma expressão into é chamada de junção em grupo.

var innerGroupJoinQuery =
    from category in categories
    join prod in products on category.ID equals prod.CategoryID into prodGroup
    select new { CategoryName = category.Name, Products = prodGroup };

Uma junção de grupo produz uma sequência de resultados hierárquica, que associa elementos na sequência de origem esquerda a um ou mais elementos correspondentes na sequência de origem do lado direito. Uma junção de grupo não tem equivalente em termos relacionais; é essencialmente uma sequência de matrizes de objetos.

Se nenhum elemento da sequência de origem direita corresponder a um elemento na origem esquerda, a join cláusula produzirá uma matriz vazia para esse item. Portanto, a junção de grupo é, basicamente, uma junção por igualdade interna, exceto pelo fato de que a sequência de resultado é organizada em grupos.

Se você selecionar apenas os resultados de uma junção de grupo, poderá acessar os itens, mas não poderá identificar a chave em que eles correspondem. Portanto, geralmente, é mais útil selecionar os resultados da junção do grupo em um novo tipo que também tenha o nome da chave, conforme mostrado no exemplo anterior.

Você também pode, é claro, usar o resultado de uma junção de grupo como gerador de outra subconsulta:

var innerGroupJoinQuery2 =
    from category in categories
    join prod in products on category.ID equals prod.CategoryID into prodGroup
    from prod2 in prodGroup
    where prod2.UnitPrice > 2.50M
    select prod2;

Para obter mais informações, consulte Executar junções agrupadas.

Junção externa esquerda

Em uma junção externa esquerda, a consulta retorna todos os elementos na sequência de origem esquerda, mesmo que nenhum elemento correspondente esteja na sequência direita. Para executar uma junção externa esquerda no LINQ, use o método DefaultIfEmpty em combinação com uma junção de grupo para especificar um elemento padrão do lado direito, que será produzido caso um elemento do lado esquerdo não tenha correspondência. Você pode usar null como o valor padrão para qualquer tipo de referência ou especificar um tipo padrão definido pelo usuário. No exemplo a seguir, um tipo padrão definido pelo usuário é mostrado:

var leftOuterJoinQuery =
    from category in categories
    join prod in products on category.ID equals prod.CategoryID into prodGroup
    from item in prodGroup.DefaultIfEmpty(new Product { Name = String.Empty, CategoryID = 0 })
    select new { CatName = category.Name, ProdName = item.Name };

Para obter mais informações, consulte Executar junções externas esquerdas.

O operador equals

Uma cláusula join realiza uma junção por igualdade. Em outras palavras, você só pode basear correspondências na igualdade de duas chaves. Não há suporte para outros tipos de comparações, como "maior que" ou "não igual a". Para deixar claro que todas as junções são equijoins, a join cláusula usa a equals palavra-chave em vez do == operador. A equals palavra-chave só pode ser usada em uma join cláusula e difere do == operador de algumas maneiras importantes. Ao comparar cadeias de caracteres, equals tem uma sobrecarga para comparar por valor e o operador == usa a igualdade de referência. Quando ambos os lados da comparação têm variáveis de cadeia de caracteres idênticas equals e == atingem o mesmo resultado: true. Isso porque, quando um programa declara duas ou mais variáveis de cadeia de caracteres equivalentes, o compilador armazena todas elas no mesmo local. Isso é conhecido como estagiamento. Outra diferença importante é a comparação nula: null equals null é avaliada como false com o operador equals, em vez do operador ==, que a avalia como true. Por último, o comportamento de escopo é diferente: com equals, a chave esquerda consome a sequência de origem externa e a chave direita consome a origem interna. A origem externa somente está no escopo no lado esquerdo de equals e a sequência de origem interna somente está no escopo no lado direito.

Junções por não igualdade

Você pode realizar junções por não igualdade, uniões cruzadas e outras operações de junção personalizadas, usando várias cláusulas from para introduzir novas sequências de maneira independente em uma consulta. Para obter mais informações, consulte Executar operações de junção personalizadas.

Junções em coleções de objetos versus tabelas relacionais

Em uma expressão de consulta LINQ, você executa operações de junção em coleções de objetos. Você não pode unir coleções de objetos exatamente da mesma maneira que duas tabelas relacionais. No LINQ, você só precisa de cláusulas explícitas join quando duas sequências de origem não têm nenhuma relação. Quando você trabalha com LINQ to SQL, o modelo de objeto representa tabelas de chaves estrangeiras como propriedades da tabela primária. Por exemplo, no banco de dados Northwind, a tabela Cliente tem uma relação de chave estrangeira com a tabela Pedidos. Quando você mapeia as tabelas para o modelo de objeto, a classe Customer tem uma Orders propriedade que contém a coleção de Orders associados a esse Cliente. Na verdade, a junção já está feita para você.

Para obter mais informações sobre como consultar entre tabelas relacionadas no contexto de LINQ para SQL, consulte Como mapear relações de banco de dados.

Chaves compostas

Você pode testar a igualdade de vários valores usando uma chave composta. Para obter mais informações, consulte Junção usando chaves compostas. Você também pode usar chaves compostas em uma group cláusula.

Exemplo

O exemplo a seguir compara os resultados de uma junção interna, uma junção de grupo e uma junção externa esquerda nas mesmas fontes de dados, usando as mesmas chaves correspondentes. Alguns códigos extras são adicionados a esses exemplos para esclarecer os resultados na exibição do console.

class JoinDemonstration
{
    #region Data

    class Product
    {
        public required string Name { get; init; }
        public required int CategoryID { get; init; }
    }

    class Category
    {
        public required string Name { get; init; }
        public required int ID { get; init; }
    }

    // Specify the first data source.
    List<Category> categories =
    [
        new Category {Name="Beverages", ID=001},
        new Category {Name="Condiments", ID=002},
        new Category {Name="Vegetables", ID=003},
        new Category {Name="Grains", ID=004},
        new Category {Name="Fruit", ID=005}
    ];

    // Specify the second data source.
    List<Product> products =
    [
      new Product {Name="Cola",  CategoryID=001},
      new Product {Name="Tea",  CategoryID=001},
      new Product {Name="Mustard", CategoryID=002},
      new Product {Name="Pickles", CategoryID=002},
      new Product {Name="Carrots", CategoryID=003},
      new Product {Name="Bok Choy", CategoryID=003},
      new Product {Name="Peaches", CategoryID=005},
      new Product {Name="Melons", CategoryID=005},
    ];
    #endregion

    static void Main(string[] args)
    {
        JoinDemonstration app = new JoinDemonstration();

        app.InnerJoin();
        app.GroupJoin();
        app.GroupInnerJoin();
        app.GroupJoin3();
        app.LeftOuterJoin();
        app.LeftOuterJoin2();
    }

    void InnerJoin()
    {
        // Create the query that selects
        // a property from each element.
        var innerJoinQuery =
           from category in categories
           join prod in products on category.ID equals prod.CategoryID
           select new { Category = category.ID, Product = prod.Name };

        Console.WriteLine("InnerJoin:");
        // Execute the query. Access results
        // with a simple foreach statement.
        foreach (var item in innerJoinQuery)
        {
            Console.WriteLine("{0,-10}{1}", item.Product, item.Category);
        }
        Console.WriteLine($"InnerJoin: {innerJoinQuery.Count()} items in 1 group.");
        Console.WriteLine(System.Environment.NewLine);
    }

    void GroupJoin()
    {
        // This is a demonstration query to show the output
        // of a "raw" group join. A more typical group join
        // is shown in the GroupInnerJoin method.
        var groupJoinQuery =
           from category in categories
           join prod in products on category.ID equals prod.CategoryID into prodGroup
           select prodGroup;

        // Store the count of total items (for demonstration only).
        int totalItems = 0;

        Console.WriteLine("Simple GroupJoin:");

        // A nested foreach statement is required to access group items.
        foreach (var prodGrouping in groupJoinQuery)
        {
            Console.WriteLine("Group:");
            foreach (var item in prodGrouping)
            {
                totalItems++;
                Console.WriteLine("   {0,-10}{1}", item.Name, item.CategoryID);
            }
        }
        Console.WriteLine($"Unshaped GroupJoin: {totalItems} items in {groupJoinQuery.Count()} unnamed groups");
        Console.WriteLine(System.Environment.NewLine);
    }

    void GroupInnerJoin()
    {
        var groupJoinQuery2 =
            from category in categories
            orderby category.ID
            join prod in products on category.ID equals prod.CategoryID into prodGroup
            select new
            {
                Category = category.Name,
                Products = from prod2 in prodGroup
                           orderby prod2.Name
                           select prod2
            };

        //Console.WriteLine("GroupInnerJoin:");
        int totalItems = 0;

        Console.WriteLine("GroupInnerJoin:");
        foreach (var productGroup in groupJoinQuery2)
        {
            Console.WriteLine(productGroup.Category);
            foreach (var prodItem in productGroup.Products)
            {
                totalItems++;
                Console.WriteLine("  {0,-10} {1}", prodItem.Name, prodItem.CategoryID);
            }
        }
        Console.WriteLine($"GroupInnerJoin: {totalItems} items in {groupJoinQuery2.Count()} named groups");
        Console.WriteLine(System.Environment.NewLine);
    }

    void GroupJoin3()
    {

        var groupJoinQuery3 =
            from category in categories
            join product in products on category.ID equals product.CategoryID into prodGroup
            from prod in prodGroup
            orderby prod.CategoryID
            select new { Category = prod.CategoryID, ProductName = prod.Name };

        //Console.WriteLine("GroupInnerJoin:");
        int totalItems = 0;

        Console.WriteLine("GroupJoin3:");
        foreach (var item in groupJoinQuery3)
        {
            totalItems++;
            Console.WriteLine($"   {item.ProductName}:{item.Category}");
        }

        Console.WriteLine($"GroupJoin3: {totalItems} items in 1 group");
        Console.WriteLine(System.Environment.NewLine);
    }

    void LeftOuterJoin()
    {
        // Create the query.
        var leftOuterQuery =
           from category in categories
           join prod in products on category.ID equals prod.CategoryID into prodGroup
           select prodGroup.DefaultIfEmpty(new Product() { Name = "Nothing!", CategoryID = category.ID });

        // Store the count of total items (for demonstration only).
        int totalItems = 0;

        Console.WriteLine("Left Outer Join:");

        // A nested foreach statement  is required to access group items
        foreach (var prodGrouping in leftOuterQuery)
        {
            Console.WriteLine("Group:");
            foreach (var item in prodGrouping)
            {
                totalItems++;
                Console.WriteLine("  {0,-10}{1}", item.Name, item.CategoryID);
            }
        }
        Console.WriteLine($"LeftOuterJoin: {totalItems} items in {leftOuterQuery.Count()} groups");
        Console.WriteLine(System.Environment.NewLine);
    }

    void LeftOuterJoin2()
    {
        // Create the query.
        var leftOuterQuery2 =
           from category in categories
           join prod in products on category.ID equals prod.CategoryID into prodGroup
           from item in prodGroup.DefaultIfEmpty()
           select new { Name = item == null ? "Nothing!" : item.Name, CategoryID = category.ID };

        Console.WriteLine($"LeftOuterJoin2: {leftOuterQuery2.Count()} items in 1 group");
        // Store the count of total items
        int totalItems = 0;

        Console.WriteLine("Left Outer Join 2:");

        // Groups have been flattened.
        foreach (var item in leftOuterQuery2)
        {
            totalItems++;
            Console.WriteLine("{0,-10}{1}", item.Name, item.CategoryID);
        }
        Console.WriteLine($"LeftOuterJoin2: {totalItems} items in 1 group");
    }
}
/*Output:

InnerJoin:
Cola      1
Tea       1
Mustard   2
Pickles   2
Carrots   3
Bok Choy  3
Peaches   5
Melons    5
InnerJoin: 8 items in 1 group.


Unshaped GroupJoin:
Group:
    Cola      1
    Tea       1
Group:
    Mustard   2
    Pickles   2
Group:
    Carrots   3
    Bok Choy  3
Group:
Group:
    Peaches   5
    Melons    5
Unshaped GroupJoin: 8 items in 5 unnamed groups


GroupInnerJoin:
Beverages
    Cola       1
    Tea        1
Condiments
    Mustard    2
    Pickles    2
Vegetables
    Bok Choy   3
    Carrots    3
Grains
Fruit
    Melons     5
    Peaches    5
GroupInnerJoin: 8 items in 5 named groups


GroupJoin3:
    Cola:1
    Tea:1
    Mustard:2
    Pickles:2
    Carrots:3
    Bok Choy:3
    Peaches:5
    Melons:5
GroupJoin3: 8 items in 1 group


Left Outer Join:
Group:
    Cola      1
    Tea       1
Group:
    Mustard   2
    Pickles   2
Group:
    Carrots   3
    Bok Choy  3
Group:
    Nothing!  4
Group:
    Peaches   5
    Melons    5
LeftOuterJoin: 9 items in 5 groups


LeftOuterJoin2: 9 items in 1 group
Left Outer Join 2:
Cola      1
Tea       1
Mustard   2
Pickles   2
Carrots   3
Bok Choy  3
Nothing!  4
Peaches   5
Melons    5
LeftOuterJoin2: 9 items in 1 group
Press any key to exit.
*/

Observações

Uma join cláusula que não é seguida se into traduz em uma Join chamada de método. Uma join cláusula que é seguida pela into tradução para uma GroupJoin chamada de método.

Consulte também

• LINQ (Palavras-chave de consulta)
• LINQ (Consulta Integrada à Linguagem)
• Operações de junção
• Cláusula de grupo
• Executar junções externas esquerdas
• Executar junções internas
• Executar junções agrupadas
• Ordenar os resultados de uma cláusula join
• Ingressar usando chaves compostas
• Sistemas de banco de dados compatíveis com o Visual Studio